com.github.fge.filesystem.attributes.provider

Class FileAttributesProvider

java.lang.Object

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

All Implemented Interfaces:

AttributeView, FileAttributeView

Direct Known Subclasses:

AclFileAttributesProvider, BasicFileAttributesProvider, DosFileAttributesProvider, FileOwnerFileAttributesProvider, PosixFileAttributesProvider, UserDefinedFileAttributesProvider

@ParametersAreNonnullByDefault
public abstract class FileAttributesProvider
extends Object
implements FileAttributeView

Basic file attribute view provider class

Use this class if you want to implement your own file attribute view.See this pagefor an example.

Unless otherwise noted, all methods defined by this class do not accept null arguments, and will throw a NullPointerException if a null argument is passed as a parameter.

See Also:

FileAttributeView

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileAttributesProvider(String name) Protected constructor

Method Summary

Methods

Modifier and Type	Method and Description
abstract Map<String,Object>	getAllAttributes() Get all attributes for this view
abstract Object	getAttributeByName(String name) Get an attribute value by name
String	name()
abstract void	setAttributeByName(String name, Object value) Set one attribute by name

Methods inherited from class java.lang.Object

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

Constructor Detail

FileAttributesProvider

protected FileAttributesProvider(String name)
                          throws IOException

Protected constructor

Parameters:

name - the name of the view

Throws:

IOException - failure to create the provider

Method Detail

name

public final String name()

Specified by:

name in interface AttributeView

setAttributeByName

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

Set one attribute by name

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

NoSuchAttributeException - an attribute by this name does not exist for this view

getAttributeByName

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

Get an attribute value by name

Parameters:

name - the name of the attribute

Returns:

the value of this attribute

Throws:

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

NoSuchAttributeException - an attribute by this name does not exist for this view

getAllAttributes

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

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.

Returns:

an immutable map of all attribute name/value pairs

Throws:

IOException - failure to read one or more attributes