ArgumentDescriptor (CRaSH Doc API 1.3.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.crsh.cli.descriptor
Class ArgumentDescriptor

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

Direct Known Subclasses:: BoundArgumentDescriptor

public class ArgumentDescriptor

extends ParameterDescriptor

Field Summary
`private String`	`name` .

Constructor Summary
`ArgumentDescriptor(String name, ParameterType<?> type, Description info, boolean required, boolean password, boolean unquote, Class<? extends Completer> completerType, Annotation annotation)`

Method Summary
`String`	`getName()` Returns the argument name, that can be null.
`Object`	`parse(List<String> values)`
`void`	`printUsage(Appendable writer)` Prints the argument: Single valued arguments use the "$arg" pattern. Multi valued arguments use the "...
`String`	`toString()`

Methods inherited from class org.crsh.cli.descriptor.ParameterDescriptor
`getAnnotation, getCompleterType, getDeclaredType, getDescription, getMultiplicity, getType, getUsage, isMultiValued, isPassword, isRequired, isSingleValued, isUnquote, parse`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

name

private final String name

Constructor Detail

ArgumentDescriptor

public ArgumentDescriptor(String name,
                          ParameterType<?> type,
                          Description info,
                          boolean required,
                          boolean password,
                          boolean unquote,
                          Class<? extends Completer> completerType,
                          Annotation annotation)
                   throws IllegalValueTypeException,
                          IllegalParameterException

Throws:: IllegalValueTypeException; IllegalParameterException

Method Detail

getName

public String getName()

Returns the argument name, that can be null. This value is used for display capabilities and does not play a role when a command line is parsed.

Returns:: the argument name

parse

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

Specified by:: parse in class ParameterDescriptor

Throws:: SyntaxException

printUsage

public void printUsage(Appendable writer)
                throws IOException

Prints the argument:

Single valued arguments use the "$arg" pattern.
Multi valued arguments use the "... $arg" pattern.

Where $arg is the value "arg" or the argument name when it is not null.

Specified by:: printUsage in class ParameterDescriptor

Parameters:: writer - the writer to print to
Throws:: IOException - any io exception

toString

public String toString()

Overrides:: toString in class Object