votorola.a

Class OutputStore.ReadyDirectory

java.lang.Object

java.io.File

OutputStore.ReadyDirectory

All Implemented Interfaces:

Serializable, Comparable<File>

Direct Known Subclasses:

ReadyDirectory, ReadyDirectory

Enclosing class:

OutputStore

@ThreadSafe
public abstract static class OutputStore.ReadyDirectory
extends File

The path to a snap/readyTrace, snap/readyCount or other output record. It is guaranteed to be in canonical form at the time of construction.

See Also:

snap/readyTrace record, snap/readyCount record, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static char	STATUS_FLAG_MOUNTED The flag character for a ready directory that is mounted.
static char	STATUS_FLAG_REPORTED The flag character for a ready directory that is currently reported.
static int	STATUS_FLAGS_COUNT The number of distinct status flags, STATUS_FLAG_*.

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OutputStore.ReadyDirectory(File file) Constructs a ReadyDirectory from a abstract (File) pathname.

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	isMounted() Answers whether the store is nominally mounted.
File	snapDirectory() The parent directory, containing the entire snapshot.
static void	statusPrintln(StringBuilder flagB, File nominalDirectory) Prints to standard output the status flags of a directory, its nominal path, and a new line.
void	statusPrintln(StringBuilder flagB, File nominalReadyDirectory, File readyDirectoryToReportOrNull) Prints to standard output the status flags of this ready directory, its nominal path, and a new line.
String	toUIString() Returns a short identifier intended for presenting to users, using a separator of " / " (space, slash, space).
String	toUIString(String separator) Returns a short identifier intended for presenting to users.

Methods inherited from class java.io.File

canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toPath, toString, toURI, toURL

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_FLAGS_COUNT

public static final int STATUS_FLAGS_COUNT

The number of distinct status flags, STATUS_FLAG_*.

STATUS_FLAG_MOUNTED

public static final char STATUS_FLAG_MOUNTED

The flag character for a ready directory that is mounted.

STATUS_FLAG_REPORTED

public static final char STATUS_FLAG_REPORTED

The flag character for a ready directory that is currently reported.

Constructor Detail

OutputStore.ReadyDirectory

protected OutputStore.ReadyDirectory(File file)
                              throws IOException

Constructs a ReadyDirectory from a abstract (File) pathname.

Parameters:

file - the abstract pathname, which will be converted to canonical form if it is non-canonical.

Throws:

FileNotFoundException - if no directory exists at the specified pathname.

IOException

Method Detail

isMounted

public abstract boolean isMounted()

Answers whether the store is nominally mounted.

snapDirectory

public final File snapDirectory()

The parent directory, containing the entire snapshot.

statusPrintln

public final void statusPrintln(StringBuilder flagB,
                 File nominalReadyDirectory,
                 File readyDirectoryToReportOrNull)

Prints to standard output the status flags of this ready directory, its nominal path, and a new line.

Parameters:

flagB - a buffer for storing the flag characters, which is not cleared herein

nominalReadyDirectory - the nominal path of this ready directory, which may differ from the canonical path

readyDirectoryToReportOrNull - the currently reported ready directory, if any is currently reported

statusPrintln

public static void statusPrintln(StringBuilder flagB,
                 File nominalDirectory)

Prints to standard output the status flags of a directory, its nominal path, and a new line.

Parameters:

flagB - a buffer of flag characters

nominalDirectory - the nominal path of the directory, which may differ from its canonical path

toUIString

public final String toUIString()

Returns a short identifier intended for presenting to users, using a separator of " / " (space, slash, space). It includes the names of the parent snap directory, and this ready directory.

toUIString

public final String toUIString(String separator)

Returns a short identifier intended for presenting to users. It includes the names of the parent snap directory, and this ready directory.

Parameters:

separator - the string to separate parent and child file names