jsimple.io

Class FileSystemDirectory

java.lang.Object

jsimple.io.Path

jsimple.io.Directory

jsimple.io.FileSystemDirectory

public class FileSystemDirectory
extends Directory

Since:

11/24/12 4:37 PM

Constructor Summary

Constructors

Constructor and Description
FileSystemDirectory(java.io.File javaFile)
FileSystemDirectory(java.lang.String directoryPath)

Method Summary

Modifier and Type	Method and Description
void	create() Create the directory, if it doesn't already exist.
void	delete() Delete this directory.
boolean	exists() See if the directory exists.
Directory	getDirectory(java.lang.String name) Get the child directory, which may or may not already exist.
File	getFile(java.lang.String name) Get a file under the directory, which may or may not already exist.
java.io.File	getJavaFile()
long	getLastModifiedTime()
java.lang.String	getName() Get the name of this file/directory--the last component of the path.
java.lang.String	getPathString() Get the string representation of the full path for this file/directory.
boolean	isSetLastModifiedTimeSupported()
void	renameTo(java.lang.String newName) Rename this directory, giving it a new name in the same parent directory.
void	setLastModifiedTime(long time) Set the last modified time for the directory, if supported by the platform (that is, if isSetLastModifiedTimeSupported() returns true).
void	visitChildren(FileVisitor fileVisitor, DirectoryVisitor directoryVisitor, VisitFailed visitFailed) Visit the child elements of this path--basically list the files and subdirectories of a directory, calling the visitor for each.

Methods inherited from class jsimple.io.Directory

createDirectory, deleteContents, isEmpty, visitChildren

Methods inherited from class jsimple.io.Path

getNameExtension, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemDirectory

public FileSystemDirectory(java.lang.String directoryPath)

FileSystemDirectory

public FileSystemDirectory(java.io.File javaFile)

Method Detail

getName

public java.lang.String getName()

Description copied from class: Path

Get the name of this file/directory--the last component of the path.

Specified by:

getName in class Path

Returns:

name of this file/directory

getPathString

public java.lang.String getPathString()

Description copied from class: Path

Get the string representation of the full path for this file/directory.

Specified by:

getPathString in class Path

Returns:

string representation of path

getFile

public File getFile(java.lang.String name)

Description copied from class: Directory

Get a file under the directory, which may or may not already exist.

Specified by:

getFile in class Directory

Parameters:

name - file name

Returns:

File object, that's a child of this directory

getDirectory

public Directory getDirectory(java.lang.String name)

Description copied from class: Directory

Get the child directory, which may or may not already exist.

Specified by:

getDirectory in class Directory

Parameters:

name - directory name

Returns:

Directory object, that's a child of this directory

exists

public boolean exists()

Description copied from class: Directory

See if the directory exists. If there's an error checking if the directory exists, this method throws an exception when possible, though for some platform implementations it'll just return false if platform can't distinguish not existing from there being an error checking.

Specified by:

exists in class Directory

Returns:

true if the file exists

create

public void create()

Description copied from class: Directory

Create the directory, if it doesn't already exist. All ancestor directories are created as well. If the directory already exists, this method does nothing.

Specified by:

create in class Directory

renameTo

public void renameTo(java.lang.String newName)

Description copied from class: Directory

Rename this directory, giving it a new name in the same parent directory. If a directory with the specified name already exists, an exception is thrown. If/when there's the need to move a Directory to a different directory, we'll add separate support for that.

Specified by:

renameTo in class Directory

visitChildren

public void visitChildren(@Nullable
                          FileVisitor fileVisitor,
                          @Nullable
                          DirectoryVisitor directoryVisitor,
                          @Nullable
                          VisitFailed visitFailed)

Visit the child elements of this path--basically list the files and subdirectories of a directory, calling the visitor for each. Just direct children are listed, not all descendants; callers can call this method recursively if they want to visit all descendants. If the path isn't a directory, an exception is thrown.

Specified by:

visitChildren in class Directory

delete

public void delete()

Description copied from class: Directory

Delete this directory. The directory must be empty; if it isn't the results are undefined--for some implementations it will fail and for others delete the directory and its contents.

Specified by:

delete in class Directory

getLastModifiedTime

public long getLastModifiedTime()

Specified by:

getLastModifiedTime in class Directory

setLastModifiedTime

public void setLastModifiedTime(long time)

Description copied from class: Directory

Set the last modified time for the directory, if supported by the platform (that is, if isSetLastModifiedTimeSupported() returns true). If not supported by the platform, this method does nothing. If supported by the platform but an error occurs when changing the last modified time (e.g. the caller doesn't have rights to change it), then this method throws an exception.

Specified by:

setLastModifiedTime in class Directory

isSetLastModifiedTimeSupported

public boolean isSetLastModifiedTimeSupported()

Specified by:

isSetLastModifiedTimeSupported in class Directory

getJavaFile

public java.io.File getJavaFile()