MethodDescriptor (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 MethodDescriptor<T>

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

 class MethodDescriptor<T>

extends CommandDescriptorImpl<T>

Field Summary
`private Method`	`method` .
`private ClassDescriptor<T>`	`owner` .
`private int`	`size` .

Constructor Summary
`MethodDescriptor(ClassDescriptor<T> owner, Method method, String name, Description info)`

Method Summary
`protected void`	`addParameter(ParameterDescriptor parameter)` Add a parameter to the command.
`CommandInvoker<T>`	`getInvoker(InvocationMatch<T> _match)`
`Method`	`getMethod()`
`CommandDescriptor<T>`	`getOwner()`
`(package private) ParameterDescriptor`	`getParameter(int index)` Returns the parameter descriptor for the specified method parameter index.
`CommandDescriptorImpl<T>`	`getSubordinate(String name)`
`Map<String,? extends CommandDescriptorImpl<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

owner

private final ClassDescriptor<T> owner

method

private final Method method

size

private final int size

Constructor Detail

MethodDescriptor

public MethodDescriptor(ClassDescriptor<T> owner,
                        Method method,
                        String name,
                        Description info)
                 throws IntrospectionException

Throws:: IntrospectionException

Method Detail

getParameter

ParameterDescriptor getParameter(int index)
                           throws IndexOutOfBoundsException

Returns the parameter descriptor for the specified method parameter index.

Parameters:: index - the parameter index
Returns:: the parameter descriptor or null if none can be bound
Throws:: IndexOutOfBoundsException - if the index is not valid

addParameter

protected void addParameter(ParameterDescriptor parameter)
                     throws IntrospectionException,
                            NullPointerException,
                            IllegalArgumentException

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; NullPointerException - if the parameter is null; IllegalArgumentException - if the parameter is already associated with another command

getOwner

public CommandDescriptor<T> getOwner()

Specified by:: getOwner in class CommandDescriptor<T>

getSubordinates

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