org.jboss.aesh.cl.internal

Class ProcessedOption

java.lang.Object

org.jboss.aesh.cl.internal.ProcessedOption

public final class ProcessedOption
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private OptionActivator	activator
private boolean	ansiMode
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 boolean	endsWithSeparator
private java.lang.String	fieldName
private boolean	longNameUsed
private java.lang.String	name
private OptionType	optionType
private boolean	overrideRequired
private java.util.Map<java.lang.String,java.lang.String>	properties
private OptionRenderer	renderer
private boolean	required
private java.lang.String	shortName
private java.lang.Class<?>	type
private OptionValidator	validator
private java.util.List<java.lang.String>	values
private char	valueSeparator

Constructor Summary

Constructors

Constructor and Description

ProcessedOption(char shortName, java.lang.String name, java.lang.String description, java.lang.String argument, boolean required, char valueSeparator, java.util.List<java.lang.String> defaultValue, java.lang.Class<?> type, java.lang.String fieldName, OptionType optionType, Converter converter, OptionCompleter completer, OptionValidator optionValidator, OptionActivator activator, OptionRenderer renderer, boolean overrideRequired)

Method Summary

Modifier and Type	Method and Description
void	addProperty(java.lang.String name, java.lang.String value)
void	addValue(java.lang.String value)
void	clear()
private java.lang.Object	doConvert(java.lang.String inputValue, InvocationProviders invocationProviders, java.lang.Object command, AeshContext aeshContext, boolean doValidation)
boolean	doOverrideRequired()
OptionActivator	getActivator()
java.lang.String	getArgument()
OptionCompleter	getCompleter()
Converter	getConverter()
java.util.List<java.lang.String>	getDefaultValues()
java.lang.String	getDescription()
java.lang.String	getDisplayName()
boolean	getEndsWithSeparator()
private java.lang.reflect.Field	getField(java.lang.Class clazz, java.lang.String fieldName)
java.lang.String	getFieldName()
int	getFormattedLength()
java.lang.String	getFormattedOption(int offset, int descriptionStart, int width)
java.lang.String	getName()
OptionType	getOptionType()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
TerminalString	getRenderedNameWithDashes()
OptionRenderer	getRenderer() might return null if render is not specified
java.lang.String	getShortName()
java.lang.Class<?>	getType()
OptionValidator	getValidator()
java.lang.String	getValue()
java.util.List<java.lang.String>	getValues()
char	getValueSeparator()
boolean	hasDefaultValue()
boolean	hasMultipleValues()
boolean	hasValue()
void	injectValueIntoField(java.lang.Object instance, InvocationProviders invocationProviders, AeshContext aeshContext, boolean doValidation)
boolean	isLongNameUsed()
boolean	isProperty()
boolean	isRequired()
private <String,T> java.util.Map<String,T>	newHashMap()
void	setEndsWithSeparator(boolean endsWithSeparator)
void	setLongNameUsed(boolean longNameUsed)
java.lang.String	toString()
void	updateAnsiMode(boolean ansiMode)
void	updateInvocationProviders(InvocationProviders invocationProviders)

Methods inherited from class java.lang.Object

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

Field Detail

shortName

private java.lang.String shortName

name

private java.lang.String name

description

private java.lang.String description

values

private java.util.List<java.lang.String> values

argument

private java.lang.String argument

defaultValues

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

type

private java.lang.Class<?> type

converter

private Converter converter

optionType

private OptionType optionType

required

private boolean required

valueSeparator

private char valueSeparator

fieldName

private java.lang.String fieldName

completer

private OptionCompleter completer

properties

private java.util.Map<java.lang.String,java.lang.String> properties

longNameUsed

private boolean longNameUsed

validator

private OptionValidator validator

endsWithSeparator

private boolean endsWithSeparator

activator

private OptionActivator activator

renderer

private OptionRenderer renderer

overrideRequired

private boolean overrideRequired

ansiMode

private boolean ansiMode

Constructor Detail

ProcessedOption

public ProcessedOption(char shortName,
                       java.lang.String name,
                       java.lang.String description,
                       java.lang.String argument,
                       boolean required,
                       char valueSeparator,
                       java.util.List<java.lang.String> defaultValue,
                       java.lang.Class<?> type,
                       java.lang.String fieldName,
                       OptionType optionType,
                       Converter converter,
                       OptionCompleter completer,
                       OptionValidator optionValidator,
                       OptionActivator activator,
                       OptionRenderer renderer,
                       boolean overrideRequired)
                throws OptionParserException

Throws:

OptionParserException

Method Detail

getShortName

public java.lang.String getShortName()

getName

public java.lang.String getName()

addValue

public void addValue(java.lang.String value)

getValue

public java.lang.String getValue()

getValues

public java.util.List<java.lang.String> getValues()

hasValue

public boolean hasValue()

hasMultipleValues

public boolean hasMultipleValues()

isRequired

public boolean isRequired()

doOverrideRequired

public boolean doOverrideRequired()

getType

public java.lang.Class<?> getType()

getDescription

public java.lang.String getDescription()

getValueSeparator

public char getValueSeparator()

isProperty

public boolean isProperty()

getArgument

public java.lang.String getArgument()

getDefaultValues

public java.util.List<java.lang.String> getDefaultValues()

addProperty

public void addProperty(java.lang.String name,
                        java.lang.String value)

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

getOptionType

public OptionType getOptionType()

getFieldName

public java.lang.String getFieldName()

getConverter

public Converter getConverter()

getCompleter

public OptionCompleter getCompleter()

getValidator

public OptionValidator getValidator()

getActivator

public OptionActivator getActivator()

getRenderer

public OptionRenderer getRenderer()

might return null if render is not specified

isLongNameUsed

public boolean isLongNameUsed()

setLongNameUsed

public void setLongNameUsed(boolean longNameUsed)

setEndsWithSeparator

public void setEndsWithSeparator(boolean endsWithSeparator)

getEndsWithSeparator

public boolean getEndsWithSeparator()

clear

public void clear()

getDisplayName

public java.lang.String getDisplayName()

getRenderedNameWithDashes

public TerminalString getRenderedNameWithDashes()

getFormattedLength

public int getFormattedLength()

getFormattedOption

public java.lang.String getFormattedOption(int offset,
                                           int descriptionStart,
                                           int width)

doConvert

private java.lang.Object doConvert(java.lang.String inputValue,
                                   InvocationProviders invocationProviders,
                                   java.lang.Object command,
                                   AeshContext aeshContext,
                                   boolean doValidation)
                            throws OptionValidatorException

Throws:

OptionValidatorException

injectValueIntoField

public void injectValueIntoField(java.lang.Object instance,
                                 InvocationProviders invocationProviders,
                                 AeshContext aeshContext,
                                 boolean doValidation)
                          throws OptionValidatorException

Throws:

OptionValidatorException

updateInvocationProviders

public void updateInvocationProviders(InvocationProviders invocationProviders)

updateAnsiMode

public void updateAnsiMode(boolean ansiMode)

newHashMap

private <String,T> java.util.Map<String,T> newHashMap()

getField

private java.lang.reflect.Field getField(java.lang.Class clazz,
                                         java.lang.String fieldName)
                                  throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

hasDefaultValue

public boolean hasDefaultValue()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object