Package org.kohsuke.args4j.spi

## Class FileOptionHandler

- java.lang.Object
- - org.kohsuke.args4j.spi.OptionHandler<T>
  - - org.kohsuke.args4j.spi.OneArgumentOptionHandler<java.io.File>
    - - org.kohsuke.args4j.spi.FileOptionHandler

    public class FileOptionHandler
    extends OneArgumentOptionHandler<java.io.File>

`File` `OptionHandler`.

Author:
  Kohsuke Kawaguchi

### Field Summary

### Fields inherited from class org.kohsuke.args4j.spi.OptionHandler

`option, owner, setter`

### Constructor Summary

Constructors
`FileOptionHandler​(CmdLineParser parser, OptionDef option, Setter<? super java.io.File> setter)`

### Method Summary

All Methods Instance Methods Concrete Methods
`java.lang.String` `getDefaultMetaVariable()` Gets the default meta variable name used to print the usage screen.
`protected java.io.File` `parse​(java.lang.String argument)` Parses a string to a real value of Type <T>.

### Methods inherited from class org.kohsuke.args4j.spi.OneArgumentOptionHandler

`parseArguments`

### Methods inherited from class org.kohsuke.args4j.spi.OptionHandler

`getMetaVariable, getNameAndMeta, getNameAndMeta, print, printDefaultValue`

### Methods inherited from class java.lang.Object

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

### Constructor Detail

#### FileOptionHandler

    public FileOptionHandler​(CmdLineParser parser,
                             OptionDef option,
                             Setter<? super java.io.File> setter)

### Method Detail

#### parse

    protected java.io.File parse​(java.lang.String argument)
                          throws CmdLineException

Description copied from class: `OneArgumentOptionHandler`
Parses a string to a real value of Type <T>.

Specified by:
  `parse` in class `OneArgumentOptionHandler<java.io.File>`
Parameters:
  `argument` - String value to parse
Returns:
  the parsed value
Throws:
  `CmdLineException` - if the parsing encounters a failure that should be reported to the user.

#### getDefaultMetaVariable

    public java.lang.String getDefaultMetaVariable()

Description copied from class: `OptionHandler`
Gets the default meta variable name used to print the usage screen. The value returned by this method can be a reference in the `ResourceBundle`, if one was passed to `CmdLineParser`.

Overrides:
  `getDefaultMetaVariable` in class `OneArgumentOptionHandler<java.io.File>`
Returns:
  `null` to hide a meta variable.