org.crsh.cli.descriptor
Class ParameterDescriptor

java.lang.Object
  org.crsh.cli.descriptor.ParameterDescriptor

Direct Known Subclasses:

ArgumentDescriptor, OptionDescriptor

public abstract class ParameterDescriptor

extends Object

description

private final Description description

.

type

private final ParameterType<?> type

.

required

private final boolean required

.

password

private final boolean password

.

completerType

private final Class<? extends Completer> completerType

.

annotation

private final Annotation annotation

The annotation when it exists.

unquote

private final boolean unquote

.

ParameterDescriptor

public ParameterDescriptor(ParameterType<?> type,
                           Description description,
                           boolean required,
                           boolean password,
                           boolean unquote,
                           Class<? extends Completer> completerType,
                           Annotation annotation)
                    throws IllegalValueTypeException,
                           IllegalParameterException

Throws:

IllegalValueTypeException

IllegalParameterException

parse

public Object parse(String s)
             throws Exception

Throws:

Exception

parse

public abstract Object parse(List<String> values)
                      throws SyntaxException

Throws:

SyntaxException

getDeclaredType

public Class<?> getDeclaredType()

getUsage

public final String getUsage()

getDescription

public Description getDescription()

getAnnotation

public Annotation getAnnotation()

isRequired

public final boolean isRequired()

isUnquote

public boolean isUnquote()

isPassword

public final boolean isPassword()

getType

public final ValueType getType()

getMultiplicity

public final Multiplicity getMultiplicity()

isSingleValued

public final boolean isSingleValued()

isMultiValued

public final boolean isMultiValued()

getCompleterType

public final Class<? extends Completer> getCompleterType()

printUsage

public abstract void printUsage(Appendable writer)
                         throws IOException

Throws:

IOException