Package org.apache.rat.commandline

Class Converters.FileConverter

java.lang.Object

org.apache.rat.commandline.Converters.FileConverter

All Implemented Interfaces:

org.apache.commons.cli.Converter<File,NullPointerException>

Enclosing class:

Converters

public static final class Converters.FileConverter
extends Object
implements org.apache.commons.cli.Converter<File,NullPointerException>

A converter that can handle relative or absolute files.

Field Summary

Fields inherited from interface org.apache.commons.cli.Converter

CLASS, DATE, DEFAULT, FILE, NUMBER, OBJECT, PATH, URL

Method Summary

Modifier and Type	Method	Description
File	apply(String fileName)	Applies the conversion function to the specified file name.
void	setWorkingDirectory(DocumentName workingDirectory)	Sets the working directory for the conversion.

Methods inherited from class java.lang.Object

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

Method Details

setWorkingDirectory

public void setWorkingDirectory(DocumentName workingDirectory)

Sets the working directory for the conversion.

Parameters:

workingDirectory - current working directory

apply

public File apply(String fileName)
           throws NullPointerException

Applies the conversion function to the specified file name.

Specified by:

apply in interface org.apache.commons.cli.Converter<File,NullPointerException>

Parameters:

fileName - the file name to create a file from.

Returns:

a File.

Throws:

NullPointerException - if fileName is null.