Package adams.core.io

Class LocalFileObject

java.lang.Object

adams.core.io.LocalFileObject

All Implemented Interfaces:

FileObject, Serializable, Comparable<FileObject>

public class LocalFileObject
extends Object
implements FileObject

Wraps a local file and avoids costly API calls by caching values.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	m_Directory	whether a directory.
protected File	m_File	the wrapped file.
protected Boolean	m_Hidden	whether the file is hidden.
protected Date	m_LastModified	the modified date.
protected Long	m_Length	the length.
protected Boolean	m_Link	whether the file is a link.

Constructor Summary

Constructors

Constructor	Description
LocalFileObject(File file)	Initializes the wrapper.

Method Summary

Modifier and Type	Method	Description
int	compareTo(FileObject o)	Returns whether this file object is the same as the provided one.
boolean	equals(Object obj)	Checks whether this object is the same as the provided one.
File	getActualFile()	Returns the actual target (if possible) in case of a link.
File	getFile()	Returns the wrapped file.
Date	getLastModified()	Returns the date when the file was last modified.
long	getLength()	Returns the size of the file.
String	getName()	Returns the file name.
FileObject	getParent()	Returns the parent, if available.
boolean	isDirectory()	Returns whether the file represents a directory.
boolean	isHidden()	Returns whether the file is hidden.
boolean	isLink()	Returns whether the file represents a link.
boolean	isLocal()	Returns whether the file is a local file.
String	toString()	Returns just the file's string representation.

Methods inherited from class java.lang.Object

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

Field Detail

m_File

protected File m_File

the wrapped file.

m_Length

protected Long m_Length

the length.

m_Directory

protected Boolean m_Directory

whether a directory.

m_LastModified

protected Date m_LastModified

the modified date.

m_Hidden

protected Boolean m_Hidden

whether the file is hidden.

m_Link

protected Boolean m_Link

whether the file is a link.

Constructor Detail

LocalFileObject

public LocalFileObject(File file)

Initializes the wrapper.

Parameters:

file - the file to wrap

Method Detail

getParent

public FileObject getParent()

Returns the parent, if available.

Specified by:

getParent in interface FileObject

Returns:

the parent or null if not available

getFile

public File getFile()

Returns the wrapped file.

Specified by:

getFile in interface FileObject

Returns:

the file

getActualFile

public File getActualFile()

Returns the actual target (if possible) in case of a link.

Specified by:

getActualFile in interface FileObject

Returns:

the actual file

getName

public String getName()

Returns the file name.

Specified by:

getName in interface FileObject

Returns:

the name

getLength

public long getLength()

Returns the size of the file.

Specified by:

getLength in interface FileObject

Returns:

the size

isDirectory

public boolean isDirectory()

Returns whether the file represents a directory.

Specified by:

isDirectory in interface FileObject

Returns:

true if directory

getLastModified

public Date getLastModified()

Returns the date when the file was last modified.

Specified by:

getLastModified in interface FileObject

Returns:

date when last modified

isHidden

public boolean isHidden()

Returns whether the file is hidden.

Specified by:

isHidden in interface FileObject

Returns:

true if hidden

isLink

public boolean isLink()

Returns whether the file represents a link.

Specified by:

isLink in interface FileObject

Returns:

true if link

isLocal

public boolean isLocal()

Returns whether the file is a local file.

Specified by:

isLocal in interface FileObject

Returns:

true if local

toString

public String toString()

Returns just the file's string representation.

Specified by:

toString in interface FileObject

Overrides:

toString in class Object

Returns:

the string representation

compareTo

public int compareTo(FileObject o)

Returns whether this file object is the same as the provided one.

Specified by:

compareTo in interface Comparable<FileObject>

Parameters:

o - the file object to compare against

Returns:

less than zero, equal to zero, greater than zero if this file object is less than, equal to, or greater than the other file object

equals

public boolean equals(Object obj)

Checks whether this object is the same as the provided one.

Overrides:

equals in class Object

Parameters:

obj - the object to compare against

Returns:

true if the same

See Also:

compareTo(FileObject)