org.oddjob.io
Class FileType

java.lang.Object
  extended by org.oddjob.io.FileType
All Implemented Interfaces:
Serializable, ArooaValue

public class FileType
extends Object
implements ArooaValue, Serializable

Description

Specify a file. In addition to being useful for configuring a job property that requires a file, this type can be used wherever an input or output is required.

This type always resolves the canonical file name.

Example

Set the CopyJob file copy example.
See Also:
Serialized Form
Author:
Rob Gordon.

Nested Class Summary
static class FileType.Conversions
           
 
Constructor Summary
FileType()
           
 
Method Summary
 File getFile()
          Getter for file.
 void setFile(File file)
          Set the file.
 File toCanonicalFile()
          The Canonical form of the file.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FileType

public FileType()
Method Detail

getFile

public File getFile()
Getter for file.

Returns:

toCanonicalFile

public File toCanonicalFile()
                     throws IOException
The Canonical form of the file.

Returns:
The Canonical form.
Throws:
IOException

setFile

public void setFile(File file)
Set the file.

Parameters:
file - The file.
Throws:
IOException

toString

public String toString()
Overrides:
toString in class Object