com.github.fge.filesystem.attributes.provider

Class AclFileAttributesProvider

java.lang.Object

com.github.fge.filesystem.attributes.provider.FileAttributesProvider

com.github.fge.filesystem.attributes.provider.AclFileAttributesProvider

All Implemented Interfaces:

AclFileAttributeView, AttributeView, FileAttributeView, FileOwnerAttributeView

@ParametersAreNonnullByDefault
public abstract class AclFileAttributesProvider
extends FileAttributesProvider
implements AclFileAttributeView

Provider for the "acl" file attribute view

By default, the list of provided ACLs is empty.

See Also:

AclFileAttributeView

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AclFileAttributesProvider()

Method Summary

Methods

Modifier and Type	Method and Description
List<AclEntry>	getAcl()
Map<String,Object>	getAllAttributes() Get all attributes for this view
Object	getAttributeByName(String name) Get an attribute value by name
void	setAcl(List<AclEntry> acl)
void	setAttributeByName(String name, Object value) Set one attribute by name
void	setOwner(UserPrincipal owner)

Methods inherited from class com.github.fge.filesystem.attributes.provider.FileAttributesProvider

name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.nio.file.attribute.AclFileAttributeView

name

Methods inherited from interface java.nio.file.attribute.FileOwnerAttributeView

getOwner

Constructor Detail

AclFileAttributesProvider

protected AclFileAttributesProvider()
                             throws IOException

Throws:

IOException

Method Detail

getAcl

public List<AclEntry> getAcl()
                      throws IOException

Specified by:

getAcl in interface AclFileAttributeView

Throws:

IOException

setOwner

public void setOwner(UserPrincipal owner)
              throws IOException

Specified by:

setOwner in interface FileOwnerAttributeView

Throws:

IOException

setAcl

public void setAcl(List<AclEntry> acl)
            throws IOException

Specified by:

setAcl in interface AclFileAttributeView

Throws:

IOException

setAttributeByName

public final void setAttributeByName(String name,
                      Object value)
                              throws IOException

Description copied from class: FileAttributesProvider

Set one attribute by name

Specified by:

setAttributeByName in class FileAttributesProvider

Parameters:

name - the name of the attribute

value - the value of the attribute

Throws:

IOException - I/O error when trying to set the attribute

ReadOnlyAttributeException - the attribute is read only

getAttributeByName

@Nullable
public final Object getAttributeByName(String name)
                                throws IOException

Description copied from class: FileAttributesProvider

Get an attribute value by name

Specified by:

getAttributeByName in class FileAttributesProvider

Parameters:

name - the name of the attribute

Returns:

the value of this attribute

Throws:

IOException - I/O error when trying to set the attribute

getAllAttributes

@Nonnull
public final Map<String,Object> getAllAttributes()
                                          throws IOException

Description copied from class: FileAttributesProvider

Get all attributes for this view

The returned map will have the attribute names as keys and their values as values. The returned map must be immutable (use Collections.unmodifiableMap(Map) for instance).

The order of keys in the returned map is not guaranteed.

Specified by:

getAllAttributes in class FileAttributesProvider

Returns:

an immutable map of all attribute name/value pairs

Throws:

IOException - failure to read one or more attributes