com.github.fge.filesystem.attributes.provider

Class BasicFileAttributesProvider

java.lang.Object

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

com.github.fge.filesystem.attributes.provider.BasicFileAttributesProvider

All Implemented Interfaces:

AttributeView, BasicFileAttributes, BasicFileAttributeView, FileAttributeView

@ParametersAreNonnullByDefault
public abstract class BasicFileAttributesProvider
extends FileAttributesProvider
implements BasicFileAttributeView, BasicFileAttributes

Provider for the "basic" file attribute view

The defaults are:

• all timestamp attribute query methods return Unix epoch;
• isSymbolicLink() and isOther() return false;
• fileKey() returns null.

See Also:

BasicFileAttributeView, BasicFileAttributes

Field Summary

Fields

Modifier and Type	Field and Description
protected static FileTime	UNIX_EPOCH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicFileAttributesProvider()

Method Summary

Methods

Modifier and Type	Method and Description
FileTime	creationTime()
Object	fileKey()
Map<String,Object>	getAllAttributes() Get all attributes for this view
Object	getAttributeByName(String name) Get an attribute value by name
boolean	isOther()
boolean	isSymbolicLink()
FileTime	lastAccessTime()
FileTime	lastModifiedTime()
BasicFileAttributes	readAttributes()
void	setAttributeByName(String name, Object value) Set one attribute by name
void	setTimes(FileTime lastModifiedTime, FileTime lastAccessTime, FileTime createTime)

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.BasicFileAttributeView

name

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

isDirectory, isRegularFile, size

Field Detail

UNIX_EPOCH

protected static final FileTime UNIX_EPOCH

Constructor Detail

BasicFileAttributesProvider

protected BasicFileAttributesProvider()
                               throws IOException

Throws:

IOException

Method Detail

readAttributes

public final BasicFileAttributes readAttributes()
                                         throws IOException

Specified by:

readAttributes in interface BasicFileAttributeView

Throws:

IOException

lastModifiedTime

public FileTime lastModifiedTime()

Specified by:

lastModifiedTime in interface BasicFileAttributes

lastAccessTime

public FileTime lastAccessTime()

Specified by:

lastAccessTime in interface BasicFileAttributes

creationTime

public FileTime creationTime()

Specified by:

creationTime in interface BasicFileAttributes

isSymbolicLink

public boolean isSymbolicLink()

Specified by:

isSymbolicLink in interface BasicFileAttributes

isOther

public boolean isOther()

Specified by:

isOther in interface BasicFileAttributes

fileKey

public Object fileKey()

Specified by:

fileKey in interface BasicFileAttributes

setTimes

public void setTimes(@Nullable
            FileTime lastModifiedTime,
            @Nullable
            FileTime lastAccessTime,
            @Nullable
            FileTime createTime)
              throws IOException

Specified by:

setTimes in interface BasicFileAttributeView

Throws:

IOException

setAttributeByName

public 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

@Nonnull
public 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