com.github.fge.filesystem.attrs

Class BasicFileAttributesBase

java.lang.Object

com.github.fge.filesystem.attrs.BasicFileAttributesBase

All Implemented Interfaces:

BasicFileAttributes

public abstract class BasicFileAttributesBase
extends Object
implements BasicFileAttributes

A base implementation of BasicFileAttributes

This abstract class defines the following (overridable) defaults:

• all methods returning a FileTime return Unix epoch by default (ie, Jan 1st, 1970 at midnight, GMT); this is what those methods must return if a particular path/time combination is not supported;
• isSymbolicLink() and isOther() both return false;
• fileKey() returns null.

Field Summary

Fields

Modifier and Type	Field and Description
protected static FileTime	UNIX_EPOCH Unix epoch as a FileTime

Constructor Summary

Constructors

Constructor and Description
BasicFileAttributesBase()

Method Summary

Methods

Modifier and Type	Method and Description
FileTime	creationTime() Returns the creation time.
Object	fileKey() Returns an object that uniquely identifies the given file, or null if a file key is not available.
boolean	isOther() Tells whether the file is something other than a regular file, directory, or symbolic link.
boolean	isSymbolicLink() Tells whether the file is a symbolic link.
FileTime	lastAccessTime() Returns the time of last access.
FileTime	lastModifiedTime() Returns the time of last modification.

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

isDirectory, isRegularFile, size

Field Detail

UNIX_EPOCH

protected static final FileTime UNIX_EPOCH

Unix epoch as a FileTime

Constructor Detail

BasicFileAttributesBase

public BasicFileAttributesBase()

Method Detail

lastModifiedTime

public FileTime lastModifiedTime()

Returns the time of last modification.

If the file system implementation does not support a time stamp to indicate the time of last modification then this method returns an implementation specific default value, typically a FileTime representing the epoch (1970-01-01T00:00:00Z).

Specified by:

lastModifiedTime in interface BasicFileAttributes

Returns:

a FileTime representing the time the file was last modified

lastAccessTime

public FileTime lastAccessTime()

Returns the time of last access.

If the file system implementation does not support a time stamp to indicate the time of last access then this method returns an implementation specific default value, typically the last-modified-time or a FileTime representing the epoch (1970-01-01T00:00:00Z).

Specified by:

lastAccessTime in interface BasicFileAttributes

Returns:

a FileTime representing the time of last access

creationTime

public FileTime creationTime()

Returns the creation time. The creation time is the time that the file was created.

If the file system implementation does not support a time stamp to indicate the time when the file was created then this method returns an implementation specific default value, typically the last-modified-time or a FileTime representing the epoch (1970-01-01T00:00:00Z).

Specified by:

creationTime in interface BasicFileAttributes

Returns:

a FileTime representing the time the file was created

isSymbolicLink

public boolean isSymbolicLink()

Tells whether the file is a symbolic link.

Specified by:

isSymbolicLink in interface BasicFileAttributes

isOther

public boolean isOther()

Tells whether the file is something other than a regular file, directory, or symbolic link.

Specified by:

isOther in interface BasicFileAttributes

fileKey

public Object fileKey()

Returns an object that uniquely identifies the given file, or null if a file key is not available. On some platforms or file systems it is possible to use an identifier, or a combination of identifiers to uniquely identify a file. Such identifiers are important for operations such as file tree traversal in file systems that support symbolic links or file systems that allow a file to be an entry in more than one directory. On UNIX file systems, for example, the device ID and inode are commonly used for such purposes.

The file key returned by this method can only be guaranteed to be unique if the file system and files remain static. Whether a file system re-uses identifiers after a file is deleted is implementation dependent and therefore unspecified.

File keys returned by this method can be compared for equality and are suitable for use in collections. If the file system and files remain static, and two files are the same with non-null file keys, then their file keys are equal.

Specified by:

fileKey in interface BasicFileAttributes

See Also:

Files.walkFileTree(java.nio.file.Path, java.util.Set<java.nio.file.FileVisitOption>, int, java.nio.file.FileVisitor<? super java.nio.file.Path>)