ClassDescriptor (CRaSH reference documentation 1.2.10 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.impl.lang
Class ClassDescriptor<T>

java.lang.Object
  org.crsh.cli.descriptor.CommandDescriptor<T>
      org.crsh.cli.impl.descriptor.CommandDescriptorImpl<T>
          org.crsh.cli.impl.lang.ClassDescriptor<T>

 class ClassDescriptor<T>

extends CommandDescriptorImpl<T>

Field Summary
`private Map<String,MethodDescriptor<T>>`	`methods` .
`private Class<T>`	`type` .

Constructor Summary
`ClassDescriptor(Class<T> type, Map<String,MethodDescriptor<T>> methods, Description info)`

Method Summary
`protected void`	`addParameter(ParameterDescriptor parameter)` Add a parameter to the command.
`(package private) void`	`configure(InvocationMatch<T> classMatch, T command)`
`CommandInvoker<T>`	`getInvoker(InvocationMatch<T> match)`
`CommandDescriptor<T>`	`getOwner()`
`MethodDescriptor<T>`	`getSubordinate(String name)`
`Map<String,? extends MethodDescriptor<T>>`	`getSubordinates()` Returns the command subordinates as a map.
`Class<T>`	`getType()`

Methods inherited from class org.crsh.cli.impl.descriptor.CommandDescriptorImpl
`completer, completer, invoker, invoker`

Methods inherited from class org.crsh.cli.descriptor.CommandDescriptor
`findOption, getArgument, getArguments, getDepth, getDescription, getLongOptionNames, getName, getOption, getOptionNames, getOptions, getParameters, getShortOptionNames, getUsage, printMan, printUsage`

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

Field Detail

type

private final Class<T> type

methods

private final Map<String,MethodDescriptor<T>> methods

Constructor Detail

ClassDescriptor

ClassDescriptor(Class<T> type,
                Map<String,MethodDescriptor<T>> methods,
                Description info)
          throws IntrospectionException

Throws:: IntrospectionException

Method Detail

addParameter

protected void addParameter(ParameterDescriptor parameter)
                     throws IntrospectionException

Description copied from class: CommandDescriptor

Add a parameter to the command.

Overrides:: addParameter in class CommandDescriptor<T>

Parameters:: parameter - the parameter to add
Throws:: IntrospectionException - any introspection exception that would prevent the parameter to be added

getInvoker

public CommandInvoker<T> getInvoker(InvocationMatch<T> match)

Specified by:: getInvoker in class CommandDescriptorImpl<T>

configure

void configure(InvocationMatch<T> classMatch,
               T command)
         throws InvocationException,
                SyntaxException

Throws:: InvocationException; SyntaxException

getOwner

public CommandDescriptor<T> getOwner()

Specified by:: getOwner in class CommandDescriptor<T>

getType

public Class<T> getType()

Specified by:: getType in class CommandDescriptor<T>

getSubordinates

public Map<String,? extends MethodDescriptor<T>> getSubordinates()