saker.build Documentation TaskDoc JavaDoc
public final class FileEntry implements BasicFileAttributes, Externalizable
Externalizable BasicFileAttributes implementation for SakerFileProvider usage.
Fields
public static final int
File type representing a directory.
public static final int
File type representing a simple file.
public static final int
File type representing a link.
public static final int
File type representing an unknown/non-existing type.
public static final int
File type representing some unknown other type.
Constructors
public
public
FileEntry(int type, long size, FileTime lastModified)
Creates a new instance with the specified arguments.
public
Creates a new instance based on the argument attributes.
Methods
public static int
Gets the file type defined by this class from the specified attributes.
public FileTime
Returns the creation time.
public boolean
Indicates whether some other object is "equal to" this one.
public Object
Returns an object that uniquely identifies the given file, or null if a file key is not available.
public long
Gets the last modified time of the file.
public long
Gets the size of the file in bytes.
public int
Gets the type of the file.
public int
Returns a hash code value for the object.
public boolean
Tells whether the file is a directory.
public boolean
Tells whether the file is something other than a regular file, directory, or symbolic link.
public boolean
Tells whether the file is a regular file with opaque content.
public boolean
Tells whether the file is a symbolic link.
public FileTime
Returns the time of last access.
public FileTime
Returns the time of last modification.
public void
Reads the externalized data from the specified data input stream.
public void
The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
public long
Returns the size of the file (in bytes).
public String
Returns a string representation of the object.
public void
Externalizes this object to the specified data output stream.
public void
The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
Inherited methods
From: Object
public static final int TYPE_DIRECTORY = 2
File type representing a directory.
public static final int TYPE_FILE = 1
File type representing a simple file.
public static final int TYPE_NULL = 0
File type representing an unknown/non-existing type.
public static final int TYPE_OTHER = 4
File type representing some unknown other type.
public FileEntry(int type, long size, FileTime lastModified) throws NullPointerException, IllegalArgumentException
Creates a new instance with the specified arguments.
typeThe type of the file.
sizeThe size of the file in bytes.
lastModifiedThe last modified time.
NullPointerExceptionIf last modified time is null.
IllegalArgumentExceptionIf the type is not a valid value declared by this class.
Creates a new instance based on the argument attributes.
attributesThe attributes to base this instance on.
NullPointerExceptionIf the argument is null.
public static int attributesToFileType(BasicFileAttributes attributes)
Gets the file type defined by this class from the specified attributes.
attributesThe attributes.
One of the file type constants declared by this class.
Overridden from: BasicFileAttributes
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).

a FileTime representing the time the file was created
public boolean equals(Object obj)
Overridden from: Object
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

objthe reference object with which to compare.
true if this object is the same as the obj argument; false otherwise.
public Object fileKey()
Overridden from: BasicFileAttributes
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.

an object that uniquely identifies the given file, or null
public long getLastModifiedMillis()
Gets the last modified time of the file.

The time is the elapsed milliseconds since the epoch defined by FileTime.toMillis().

The last modified time in milliseconds.
public long getSize()
Gets the size of the file in bytes.
The size of the file.
public int getType()
Gets the type of the file.

The file type is one of the constants declared in this class starting with TYPE_.

The type of the file.
public int hashCode()
Overridden from: Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the Object.equals(Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

a hash code value for this object.
public boolean isDirectory()
Overridden from: BasicFileAttributes
Tells whether the file is a directory.
true if the file is a directory
public boolean isOther()
Overridden from: BasicFileAttributes
Tells whether the file is something other than a regular file, directory, or symbolic link.
true if the file something other than a regular file, directory or symbolic link
public boolean isRegularFile()
Overridden from: BasicFileAttributes
Tells whether the file is a regular file with opaque content.
true if the file is a regular file with opaque content
Overridden from: BasicFileAttributes
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).

a FileTime representing the time of last access
Overridden from: BasicFileAttributes
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).

a FileTime representing the time the file was last modified
public void readExternal(DataInput in) throws IOException
Reads the externalized data from the specified data input stream.
inThe data input.
IOExceptionIn case of I/O error.
Overridden from: Externalizable
The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.
inthe stream to read data from in order to restore the object
IOExceptionif I/O errors occur
ClassNotFoundExceptionIf the class for an object being restored cannot be found.
public long size()
Overridden from: BasicFileAttributes
Returns the size of the file (in bytes). The size may differ from the actual size on the file system due to compression, support for sparse files, or other reasons. The size of files that are not regular files is implementation specific and therefore unspecified.
the file size, in bytes
public String toString()
Overridden from: Object
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 
a string representation of the object.
public void writeExternal(DataOutput out) throws IOException
Externalizes this object to the specified data output stream.
outThe data output.
IOExceptionIn case of I/O error.
public void writeExternal(ObjectOutput out) throws IOException
Overridden from: Externalizable
The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
outthe stream to write the object to
IOExceptionIncludes any I/O exceptions that may occur