org.oddjob.io

Class FileType

java.lang.Object

org.oddjob.io.FileType

All Implemented Interfaces:

java.io.Serializable, ArooaValue

public class FileType
extends java.lang.Object
implements ArooaValue, java.io.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

Nested Classes

Modifier and Type	Class and Description
static class	FileType.Conversions

Constructor Summary

Constructors

Constructor and Description
FileType()

Method Summary

Modifier and Type	Method and Description
java.io.File	getFile() Getter for file.
void	setFile(java.io.File file) Set the file.
java.io.File	toCanonicalFile() The Canonical form of the file.
java.lang.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 java.io.File getFile()

Getter for file.

Returns:

toCanonicalFile

public java.io.File toCanonicalFile()
                             throws java.io.IOException

The Canonical form of the file.

Returns:

The Canonical form.

Throws:

java.io.IOException

setFile

public void setFile(java.io.File file)

Set the file.

Parameters:

file - The file.

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object