org.jboss.aesh.cl.internal

Class ProcessedOptionBuilder

java.lang.Object

org.jboss.aesh.cl.internal.ProcessedOptionBuilder

public class ProcessedOptionBuilder
extends java.lang.Object

Build a ProcessedOption object using the Builder pattern.

Field Summary

Fields

Modifier and Type	Field and Description
private OptionActivator	activator
private java.lang.String	argument
private OptionCompleter	completer
private Converter	converter
private java.util.List<java.lang.String>	defaultValues
private java.lang.String	description
private java.lang.String	fieldName
private boolean	hasMultipleValues
private boolean	hasValue
private boolean	isProperty
private java.lang.String	name
private OptionType	optionType
private boolean	overrideRequired
private OptionRenderer	renderer
private boolean	required
private char	shortName
private java.lang.Class<?>	type
private OptionValidator	validator
private char	valueSeparator

Constructor Summary

Constructors

Constructor and Description
ProcessedOptionBuilder()

Method Summary

Modifier and Type	Method and Description
ProcessedOptionBuilder	activator(java.lang.Class<? extends OptionActivator> activator)
ProcessedOptionBuilder	activator(OptionActivator activator)
ProcessedOptionBuilder	addAllDefaultValues(java.util.List<java.lang.String> defaultValues)
ProcessedOptionBuilder	addAllDefaultValues(java.lang.String[] defaultValues)
ProcessedOptionBuilder	addDefaultValue(java.lang.String defaultValue)
ProcessedOptionBuilder	argument(java.lang.String argument) A description on what kind of value is used for this option.
ProcessedOptionBuilder	completer(java.lang.Class<? extends OptionCompleter> completer)
ProcessedOptionBuilder	completer(OptionCompleter completer)
ProcessedOptionBuilder	converter(java.lang.Class<? extends Converter> converter)
ProcessedOptionBuilder	converter(Converter converter)
ProcessedOption	create()
ProcessedOptionBuilder	description(java.lang.String description) A description of the param.
ProcessedOptionBuilder	fieldName(java.lang.String fieldName)
ProcessedOptionBuilder	hasMultipleValues(boolean hasMultipleValues)
ProcessedOptionBuilder	hasValue(boolean hasValue)
private OptionActivator	initActivator(java.lang.Class<? extends OptionActivator> activator)
private OptionCompleter	initCompleter(java.lang.Class<? extends OptionCompleter> completerClass)
private Converter	initConverter(java.lang.Class<? extends Converter> converterClass)
private OptionRenderer	initRenderer(java.lang.Class<? extends OptionRenderer> renderer)
private OptionValidator	initValidator(java.lang.Class<? extends OptionValidator> validator)
ProcessedOptionBuilder	isProperty(boolean isProperty)
ProcessedOptionBuilder	name(java.lang.String name) The name of the option param.
ProcessedOptionBuilder	optionType(OptionType optionType)
ProcessedOptionBuilder	overrideRequired(boolean overrideRequired)
ProcessedOptionBuilder	renderer(java.lang.Class<? extends OptionRenderer> renderer)
ProcessedOptionBuilder	renderer(OptionRenderer renderer)
ProcessedOptionBuilder	required(boolean required) Specify if this option is required
ProcessedOptionBuilder	shortName(char n) The short option Name
ProcessedOptionBuilder	type(java.lang.Class<?> type) Define the Class type of this Option.
ProcessedOptionBuilder	validator(java.lang.Class<? extends OptionValidator> validator)
ProcessedOptionBuilder	validator(OptionValidator validator)
ProcessedOptionBuilder	valueSeparator(char valueSeparator)

Methods inherited from class java.lang.Object

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

Field Detail

shortName

private char shortName

name

private java.lang.String name

description

private java.lang.String description

argument

private java.lang.String argument

type

private java.lang.Class<?> type

hasValue

private boolean hasValue

required

private boolean required

isProperty

private boolean isProperty

hasMultipleValues

private boolean hasMultipleValues

valueSeparator

private char valueSeparator

optionType

private OptionType optionType

converter

private Converter converter

fieldName

private java.lang.String fieldName

completer

private OptionCompleter completer

defaultValues

private final java.util.List<java.lang.String> defaultValues

validator

private OptionValidator validator

activator

private OptionActivator activator

renderer

private OptionRenderer renderer

overrideRequired

private boolean overrideRequired

Constructor Detail

ProcessedOptionBuilder

public ProcessedOptionBuilder()

Method Detail

shortName

public ProcessedOptionBuilder shortName(char n)

The short option Name

name

public ProcessedOptionBuilder name(java.lang.String name)

The name of the option param. The first letter will be used as the short name. If name is not defined, the variable name will be used.

description

public ProcessedOptionBuilder description(java.lang.String description)

A description of the param. This text will be printed out as part of a usage info.

argument

public ProcessedOptionBuilder argument(java.lang.String argument)

A description on what kind of value is used for this option.

type

public ProcessedOptionBuilder type(java.lang.Class<?> type)

Define the Class type of this Option. If this option is a multiple value option this Class must be defined equal to the parameterized class type. Note that the If its a property option the

Parameters:

type -

Returns:

required

public ProcessedOptionBuilder required(boolean required)

Specify if this option is required

fieldName

public ProcessedOptionBuilder fieldName(java.lang.String fieldName)

hasValue

public ProcessedOptionBuilder hasValue(boolean hasValue)

isProperty

public ProcessedOptionBuilder isProperty(boolean isProperty)

hasMultipleValues

public ProcessedOptionBuilder hasMultipleValues(boolean hasMultipleValues)

addDefaultValue

public ProcessedOptionBuilder addDefaultValue(java.lang.String defaultValue)

addAllDefaultValues

public ProcessedOptionBuilder addAllDefaultValues(java.util.List<java.lang.String> defaultValues)

addAllDefaultValues

public ProcessedOptionBuilder addAllDefaultValues(java.lang.String[] defaultValues)

valueSeparator

public ProcessedOptionBuilder valueSeparator(char valueSeparator)

optionType

public ProcessedOptionBuilder optionType(OptionType optionType)

converter

public ProcessedOptionBuilder converter(Converter converter)

converter

public ProcessedOptionBuilder converter(java.lang.Class<? extends Converter> converter)

initConverter

private Converter initConverter(java.lang.Class<? extends Converter> converterClass)

completer

public ProcessedOptionBuilder completer(OptionCompleter completer)

completer

public ProcessedOptionBuilder completer(java.lang.Class<? extends OptionCompleter> completer)

initCompleter

private OptionCompleter initCompleter(java.lang.Class<? extends OptionCompleter> completerClass)

validator

public ProcessedOptionBuilder validator(OptionValidator validator)

validator

public ProcessedOptionBuilder validator(java.lang.Class<? extends OptionValidator> validator)

initValidator

private OptionValidator initValidator(java.lang.Class<? extends OptionValidator> validator)

activator

public ProcessedOptionBuilder activator(OptionActivator activator)

activator

public ProcessedOptionBuilder activator(java.lang.Class<? extends OptionActivator> activator)

initActivator

private OptionActivator initActivator(java.lang.Class<? extends OptionActivator> activator)

renderer

public ProcessedOptionBuilder renderer(OptionRenderer renderer)

renderer

public ProcessedOptionBuilder renderer(java.lang.Class<? extends OptionRenderer> renderer)

initRenderer

private OptionRenderer initRenderer(java.lang.Class<? extends OptionRenderer> renderer)

overrideRequired

public ProcessedOptionBuilder overrideRequired(boolean overrideRequired)

create

public ProcessedOption create()
                       throws OptionParserException

Throws:

OptionParserException