Package org.kohsuke.args4j.spi

## Class PatternOptionHandler

- java.lang.Object
- - org.kohsuke.args4j.spi.OptionHandler<java.util.regex.Pattern>
  - - org.kohsuke.args4j.spi.PatternOptionHandler

    public class PatternOptionHandler
    extends OptionHandler<java.util.regex.Pattern>

A regex option handler.

Author:
  Stephan Fuhrmann

### Field Summary

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

`option, owner, setter`

### Constructor Summary

Constructors
`PatternOptionHandler​(CmdLineParser parser, OptionDef option, Setter<java.util.regex.Pattern> 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.
`int` `parseArguments​(Parameters params)` Called if the option that this owner recognizes is found.

### 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

#### PatternOptionHandler

    public PatternOptionHandler​(CmdLineParser parser,
                                OptionDef option,
                                Setter<java.util.regex.Pattern> setter)

### Method Detail

#### parseArguments

    public int parseArguments​(Parameters params)
                       throws CmdLineException

Description copied from class: `OptionHandler`
Called if the option that this owner recognizes is found.

Specified by:
  `parseArguments` in class `OptionHandler<java.util.regex.Pattern>`
Parameters:
  `params` - The rest of the arguments. This method can use this object to access the arguments of the option if necessary. The object is valid only during the method call.
Returns:
  The number of arguments consumed. (For example, returns `0` if this option doesn't take any parameters.)
Throws:
  `CmdLineException`

#### 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`.

Specified by:
  `getDefaultMetaVariable` in class `OptionHandler<java.util.regex.Pattern>`
Returns:
  `null` to hide a meta variable.