org.sonatype.gshell.util.cli2
Class CliDescriptor

java.lang.Object
  org.sonatype.gshell.util.AnnotationDescriptor
      org.sonatype.gshell.util.cli2.CliDescriptor

Direct Known Subclasses:

ArgumentDescriptor, OptionDescriptor

public abstract class CliDescriptor
extends AnnotationDescriptor

Base-class for CLI descriptors.

Since:

2.3

Author:

Jason Dillon

Field Summary

Fields inherited from class org.sonatype.gshell.util.AnnotationDescriptor

UNINITIALIZED_CHAR, UNINITIALIZED_CLASS, UNINITIALIZED_STRING

Constructor Summary

CliDescriptor(Object spec, Setter setter)

Method Summary

String	getDescription()
Handler	getHandler()
Class	getHandlerType()
String	getId()
String	getMessageCode()
Setter	getSetter()
abstract String	getSyntax()
String	getToken()
String	getTokenCode()
Class	getType()
boolean	isArgument()
boolean	isMultiValued()
boolean	isOption()
boolean	isRequired()
String	renderHelpText(MessageSource messages)
String	renderSyntax(MessageSource messages)
String	renderToken(MessageSource messages)

Methods inherited from class org.sonatype.gshell.util.AnnotationDescriptor

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CliDescriptor

public CliDescriptor(Object spec,
                     Setter setter)

Method Detail

getId

public String getId()

getSetter

public Setter getSetter()

isMultiValued

public boolean isMultiValued()

getType

public Class getType()

getToken

public String getToken()

isRequired

public boolean isRequired()

getDescription

public String getDescription()

getHandlerType

public Class getHandlerType()

getHandler

public Handler getHandler()

isArgument

public boolean isArgument()

isOption

public boolean isOption()

getMessageCode

public String getMessageCode()

getTokenCode

public String getTokenCode()

getSyntax

public abstract String getSyntax()

renderSyntax

public String renderSyntax(MessageSource messages)

renderToken

public String renderToken(MessageSource messages)

renderHelpText

public String renderHelpText(MessageSource messages)