jsimple.io

Class Directory

java.lang.Object

jsimple.io.Path

jsimple.io.Directory

Direct Known Subclasses:

FileSystemDirectory

public abstract class Directory
extends Path

Since:

11/22/12 12:14 AM

Constructor Summary

Constructors

Constructor and Description
Directory()

Method Summary

Modifier and Type	Method and Description
abstract void	create() Create the directory, if it doesn't already exist.
Directory	createDirectory(java.lang.String name) Get the child directory, creating it if it doesn't already exist.
abstract void	delete() Delete this directory.
void	deleteContents() Delete the contents of this directory, recursi vely.
abstract boolean	exists() See if the directory exists.
abstract Directory	getDirectory(java.lang.String name) Get the child directory, which may or may not already exist.
abstract File	getFile(java.lang.String name) Get a file under the directory, which may or may not already exist.
abstract long	getLastModifiedTime()
boolean	isEmpty() Check if this directory has any contents.
abstract boolean	isSetLastModifiedTimeSupported()
abstract void	renameTo(java.lang.String newName) Rename this directory, giving it a new name in the same parent directory.
abstract 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) Visit the child elements of this path--basically list the files and subdirectories of a directory, calling the visitor for each.
abstract 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.Path

getName, getNameExtension, getPathString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Directory

public Directory()

Method Detail

getFile

public abstract File getFile(java.lang.String name)

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

Parameters:

name - file name

Returns:

File object, that's a child of this directory

getDirectory

public abstract Directory getDirectory(java.lang.String name)

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

Parameters:

name - directory name

Returns:

Directory object, that's a child of this directory

createDirectory

public Directory createDirectory(java.lang.String name)

Get the child directory, creating it if it doesn't already exist.

Parameters:

name - directory name

Returns:

Directory object, that's a child of this directory

exists

public abstract boolean exists()

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.

Returns:

true if the file exists

create

public abstract void create()

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.

renameTo

public abstract void renameTo(java.lang.String newName)

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.

Parameters:

newName -

visitChildren

public abstract 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.

visitChildren

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

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.

delete

public abstract void delete()

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.

getLastModifiedTime

public abstract long getLastModifiedTime()

setLastModifiedTime

public abstract void setLastModifiedTime(long time)

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.

Parameters:

time -

isSetLastModifiedTimeSupported

public abstract boolean isSetLastModifiedTimeSupported()

deleteContents

public void deleteContents()

Delete the contents of this directory, recursi vely.

isEmpty

public boolean isEmpty()

Check if this directory has any contents.

Returns:

true if the directory is empty, containing no files or subdirectories