org.kohsuke.args4j.opts

Class FileOption

java.lang.Object

org.kohsuke.args4j.opts.FileOption

All Implemented Interfaces:

CmdLineOption

public class FileOption
extends Object
implements CmdLineOption

Option that takes File as a parameter.

Author:

Kohsuke Kawaguchi (kk@kohsuke.org)

Nested Class Summary

Nested classes/interfaces inherited from interface org.kohsuke.args4j.CmdLineOption

CmdLineOption.Parameters

Field Summary

Fields

Modifier and Type	Field and Description
File	value Value of this option.

Constructor Summary

Constructors

Constructor and Description
FileOption(String optionName)
FileOption(String optionName, File defaultValue)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accepts(String optionName) Checks if this option parser recognizes the specified option name.
int	parseArguments(CmdLineParser parser, CmdLineOption.Parameters params) Called if the option that this parser recognizes is found.

Methods inherited from class java.lang.Object

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

Field Detail

value

public File value

Value of this option.

Constructor Detail

FileOption

public FileOption(String optionName)

FileOption

public FileOption(String optionName,
          File defaultValue)

Method Detail

accepts

public boolean accepts(String optionName)

Description copied from interface: CmdLineOption

Checks if this option parser recognizes the specified option name.

Specified by:

accepts in interface CmdLineOption

parseArguments

public int parseArguments(CmdLineParser parser,
                 CmdLineOption.Parameters params)
                   throws CmdLineException

Description copied from interface: CmdLineOption

Called if the option that this parser recognizes is found.

Specified by:

parseArguments in interface CmdLineOption

Parameters:

parser - The parser that's using this option object. For example, if the option "-quiet" is simply an alias to "-verbose 5", then the implementation can just call the CmdLineParser.parse(String[]) method recursively.

params - The rest of the arguments. This method can use this object to access the arguments of the option if necessary.

Returns:

The number of arguments consumed. For example, return 0 if this option doesn't take any parameter.

Throws:

CmdLineException