Package adams.core.io

Class FlowFile

java.lang.Object

java.io.File

adams.core.io.PlaceholderFile

adams.core.io.FlowFile

All Implemented Interfaces:

Serializable, Comparable<File>

public class FlowFile
extends PlaceholderFile

A specialized File class used for flows.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

Constructor	Description
FlowFile(File file)	Creates a new FlowFile instance by using the given file.
FlowFile(File parent, String child)	Creates a new File instance from a parent abstract pathname and a child pathname string.
FlowFile(String pathname)	Creates a new File instance by converting the given pathname string into an abstract pathname.
FlowFile(String parent, String child)	Creates a new File instance from a parent pathname string and a child pathname string.
FlowFile(URI uri)	Creates a new File instance by converting the given file: URI into an abstract pathname.

Method Summary

Methods inherited from class adams.core.io.PlaceholderFile

canExecute, canRead, canWrite, changeExtension, changeExtension, compareTo, createNewFile, delete, deleteOnExit, exists, expand, fixSeparator, fixSeparator, getAbsolutePath, getCanonicalPath, getExtension, getExtension, getFreeSpace, getParent, getParentFile, getTotalSpace, getUsableSpace, isAbsolute, isDirectory, isFile, isHidden, isValid, isValid, lastModified, length, list, list, listFiles, listFiles, listFiles, mkdir, renameTo, setExecutable, setLastModified, setReadable, setReadOnly, setWritable, toPath, toPlaceholderFiles

Methods inherited from class java.io.File

createTempFile, createTempFile, equals, getAbsoluteFile, getCanonicalFile, getName, getPath, hashCode, list, listRoots, mkdirs, setExecutable, setReadable, setWritable, toString, toURI, toURL

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowFile

public FlowFile(File file)

Creates a new FlowFile instance by using the given file.

Parameters:

file - the file to use

FlowFile

public FlowFile(String pathname)

Creates a new File instance by converting the given pathname string into an abstract pathname. If the given string is the empty string, then the result is the empty abstract pathname.

Parameters:

pathname - A pathname string

FlowFile

public FlowFile(String parent,
                String child)

Creates a new File instance from a parent pathname string and a child pathname string.

If parent is null then the new File instance is created as if by invoking the single-argument File constructor on the given child pathname string.

Otherwise the parent pathname string is taken to denote a directory, and the child pathname string is taken to denote either a directory or a file. If the child pathname string is absolute then it is converted into a relative pathname in a system-dependent way. If parent is the empty string then the new File instance is created by converting child into an abstract pathname and resolving the result against a system-dependent default directory. Otherwise each pathname string is converted into an abstract pathname and the child abstract pathname is resolved against the parent.

Parameters:

parent - The parent pathname string

child - The child pathname string

FlowFile

public FlowFile(File parent,
                String child)

Creates a new File instance from a parent abstract pathname and a child pathname string.

If parent is null then the new File instance is created as if by invoking the single-argument File constructor on the given child pathname string.

Otherwise the parent abstract pathname is taken to denote a directory, and the child pathname string is taken to denote either a directory or a file. If the child pathname string is absolute then it is converted into a relative pathname in a system-dependent way. If parent is the empty abstract pathname then the new File instance is created by converting child into an abstract pathname and resolving the result against a system-dependent default directory. Otherwise each pathname string is converted into an abstract pathname and the child abstract pathname is resolved against the parent.

Parameters:

parent - The parent abstract pathname

child - The child pathname string

FlowFile

public FlowFile(URI uri)

Creates a new File instance by converting the given file: URI into an abstract pathname.

The exact form of a file: URI is system-dependent, hence the transformation performed by this constructor is also system-dependent.

For a given abstract pathname f it is guaranteed that

new File( f.toURI()).equals( f.getAbsoluteFile())

so long as the original abstract pathname, the URI, and the new abstract pathname are all created in (possibly different invocations of) the same Java virtual machine. This relationship typically does not hold, however, when a file: URI that is created in a virtual machine on one operating system is converted into an abstract pathname in a virtual machine on a different operating system.

Parameters:

uri - An absolute, hierarchical URI with a scheme equal to "file", a non-empty path component, and undefined authority, query, and fragment components