ParameterNode (common 4.0.0-beta.17 API)

Type Parameters:

A - The actor type

T - The parameter type, for type-safety.

All Superinterfaces:

CommandNode<A>, java.lang.Comparable<CommandNode<A>>, HasDescription, RequiresPermission<A>
```
public interface ParameterNode<A extends CommandActor,T>
extends CommandNode<A>, RequiresPermission<A>, HasDescription
```
Represents a parameter node. This node has a specific parameterType() that can parse the content of MutableStringStream and generate the appropriate values.
Note that this node will always correspond to a reflective Parameter through the parameter() type.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`@NotNull AnnotationList`	`annotations()` Returns the annotations present on this `ParameterNode`.
`@NotNull java.util.Collection<java.lang.String>`	`complete(A actor, @NotNull StringStream input, @NotNull ExecutionContext<A> context)` Provides suggestions for the given user input.
`@Nullable java.lang.String`	`flagName()` Gets the flag name defined in `Flag.value()`.
`default @NotNull java.lang.reflect.Type`	`fullType()` Returns the parameter Java type
`boolean`	`isFlag()` Tests whether this parameter is a flag
`boolean`	`isGreedy()` Tests whether is this parameter greedy or not
`default boolean`	`isLiteral()` Tests whether this node is a `LiteralNode`.
`boolean`	`isOptional()` Tests whether is this parameter optional or not.
`default boolean`	`isParameter()` Tests whether this node is a `ParameterNode`.
`default boolean`	`isRequired()` Tests whether is this parameter required or not.
`boolean`	`isSwitch()` Tests whether this parameter is a switch
`@NotNull CommandParameter`	`parameter()` Returns the underlying `CommandParameter` of this parameter node
`@NotNull ParameterType<A,T>`	`parameterType()` Returns the `ParameterType` of this parameter that will be used to parse the input.
`T`	`parse(MutableStringStream input, ExecutionContext<A> context)` Parses the given input and produces the appropriate value for the input.
`default @NotNull LiteralNode<A>`	`requireLiteralNode()` Requires this node to be a `LiteralNode`.
`@Nullable java.lang.Character`	`shorthand()` Gets the shorthand defined from either `Flag.shorthand()` or `Switch.shorthand()`.
`@NotNull SuggestionProvider<A>`	`suggestions()` Returns the suggestion provider for this parameter node.
`@Nullable java.lang.String`	`switchName()` Gets the switch name defined in `Switch.value()`.
`default @NotNull java.lang.Class<?>`	`type()` Returns the parameter Java type

Methods inherited from interface revxrsal.commands.node.CommandNode
action, command, execute, hasAction, isLast, lamp, name, representation, requireParameterNode

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface revxrsal.commands.node.RequiresPermission
permission

Methods inherited from interface revxrsal.commands.node.HasDescription
description

- Method Detail
  - parse
```
@Nullable
T parse(MutableStringStream input,
                  ExecutionContext<A> context)
```
    Parses the given input and produces the appropriate value for the input.
    If this parameter was optional, or has a default value, it will be used if the input is not sufficient.
    This may produce null values in case of isOptional() parameters as well as ParameterTypes that may return a null value
    
    Parameters:
    
    input - The input type
    
    context - The execution context
    
    Returns:
    
    The resolved type.
  - annotations
```
@NotNull
@NotNull AnnotationList annotations()
```
    Returns the annotations present on this ParameterNode.
    
    Returns:
    
    The annotations on this node.
  - isOptional
```
boolean isOptional()
```
    Tests whether is this parameter optional or not.
    This will return true in these cases:
    1. It is marked with @Optional
    2. It has a default value from @Default
    3. It has @Sized with min() == 0
    Returns:
    
    if this parameter is optional
  - isRequired
```
default boolean isRequired()
```
    Tests whether is this parameter required or not.
    This will return false in these cases:
    1. It is marked with @Optional
    2. It has a default value from @Default
    3. It has @Sized with min() == 0
    Returns:
    
    if this parameter is required
  - parameterType
```
@NotNull
@NotNull ParameterType<A,T> parameterType()
```
    Returns the ParameterType of this parameter that will be used to parse the input.
    
    Returns:
    
    The parameter type
  - suggestions
```
@NotNull
@NotNull SuggestionProvider<A> suggestions()
```
    Returns the suggestion provider for this parameter node. This node would either be generated by relevant factories or have the default suggestions from ParameterType.defaultSuggestions().
    
    Returns:
    
    The suggestion provider of this node
  - parameter
```
@NotNull
@NotNull CommandParameter parameter()
```
    Returns the underlying CommandParameter of this parameter node
    
    Returns:
    
    The underlying CommandParameter.
  - isGreedy
```
boolean isGreedy()
```
    Tests whether is this parameter greedy or not
    
    Returns:
    
    if this parameter is greedy
  - complete
```
@Contract(pure=true)
 @NotNull
@NotNull java.util.Collection<java.lang.String> complete(A actor,
                                                                                        @NotNull
                                                                                        @NotNull StringStream input,
                                                                                        @NotNull
                                                                                        @NotNull ExecutionContext<A> context)
```
    Provides suggestions for the given user input.
    
    Parameters:
    
    actor - The actor to generate for
    
    input - The command input
    
    context - The execution context.
    
    Returns:
    
    The
  - type
```
@NotNull
default @NotNull java.lang.Class<?> type()
```
    Returns the parameter Java type
    
    Returns:
    
    The parameter type
  - fullType
```
@NotNull
default @NotNull java.lang.reflect.Type fullType()
```
    Returns the parameter Java type
    
    Returns:
    
    The parameter type
  - isLiteral
```
default boolean isLiteral()
```
    Tests whether this node is a LiteralNode. This will always return false
    
    Specified by:
    
    isLiteral in interface CommandNode<A extends CommandActor>
    
    Returns:
    
    if this node is literal
  - isParameter
```
default boolean isParameter()
```
    Tests whether this node is a ParameterNode. This will always return true
    
    Specified by:
    
    isParameter in interface CommandNode<A extends CommandActor>
    
    Returns:
    
    if this node is a parameter
  - requireLiteralNode
```
@Contract(value="-> fail")
 @NotNull
default @NotNull LiteralNode<A> requireLiteralNode()
```
    Requires this node to be a LiteralNode. This will throw a IllegalStateException.
    
    Specified by:
    
    requireLiteralNode in interface CommandNode<A extends CommandActor>
    
    Returns:
    
    never as it always fails
    
    Throws:
    
    java.lang.IllegalStateException - always
  - isFlag
```
boolean isFlag()
```
    Tests whether this parameter is a flag
    
    Returns:
    
    if this parameter is a flag
    
    See Also:
    
    Flag
  - isSwitch
```
boolean isSwitch()
```
    Tests whether this parameter is a switch
    
    Returns:
    
    if this parameter is a switch
    
    See Also:
    
    Switch
  - shorthand
```
@Nullable
 @Contract(pure=true)
@Nullable java.lang.Character shorthand()
```
    Gets the shorthand defined from either Flag.shorthand() or Switch.shorthand(). This may return null if this parameter is neither a flag nor a switch.
    
    Returns:
    
    The shorthand, or null if not defined.
  - switchName
```
@Nullable
 @Contract(pure=true)
@Nullable java.lang.String switchName()
```
    Gets the switch name defined in Switch.value(). This may return null if this parameter is not a switch.
    
    Returns:
    
    The switch name, or null if not defined.
  - flagName
```
@Nullable
 @Contract(pure=true)
@Nullable java.lang.String flagName()
```
    Gets the flag name defined in Flag.value(). This may return null if this parameter is not a flag.
    
    Returns:
    
    The switch name, or null if not defined.

Interface ParameterNode<A extends CommandActor,T>

Method Summary

Methods inherited from interface revxrsal.commands.node.CommandNode

Methods inherited from interface java.lang.Comparable

Methods inherited from interface revxrsal.commands.node.RequiresPermission

Methods inherited from interface revxrsal.commands.node.HasDescription

Method Detail

parse

annotations

isOptional

isRequired

parameterType

suggestions

parameter

isGreedy

complete

type

fullType

isLiteral

isParameter

requireLiteralNode

isFlag

isSwitch

shorthand

switchName

flagName