com.sk89q.intake.parametric

Class ParameterConsumer

java.lang.Object

com.sk89q.intake.parametric.ParameterConsumer

public class ParameterConsumer
extends Object

Takes a list of Parameters and parses arguments out of a CommandContext.

Constructor Summary

Constructors

Constructor and Description
ParameterConsumer(List<? extends ParameterData<?>> parameters) Create a new instance.

Method Summary

Modifier and Type	Method and Description
Object[]	parseArguments(CommandContext context) Parse arguments out of the given context.
Object[]	parseArguments(CommandContext context, boolean ignoreUnusedFlags, Set<Character> unusedFlags) Parse arguments out of the given context.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterConsumer

public ParameterConsumer(List<? extends ParameterData<?>> parameters)

Create a new instance.

Parameters:

parameters - the list of parameters

Method Detail

parseArguments

public Object[] parseArguments(CommandContext context)
                        throws CommandException,
                               InvocationTargetException,
                               ConsumeException,
                               UnconsumedParameterException

Parse arguments out of the given context.

Parameters:

context - the context

Returns:

the parsed arguments

Throws:

CommandException - thrown on an error raised by the command

InvocationTargetException - thrown if invocation fails

ConsumeException - thrown if the conumption of an argument fails

UnconsumedParameterException - thrown if there are too many arguments

parseArguments

public Object[] parseArguments(CommandContext context,
                               boolean ignoreUnusedFlags,
                               Set<Character> unusedFlags)
                        throws CommandException,
                               InvocationTargetException,
                               ConsumeException,
                               UnconsumedParameterException

Parse arguments out of the given context.

Parameters:

context - the context

ignoreUnusedFlags - true to not check if there are consumed flags

unusedFlags - list of flags to ignore if they are not consumed

Returns:

the parsed arguments

Throws:

CommandException - thrown on an error raised by the command

InvocationTargetException - thrown if invocation fails

ConsumeException - thrown if the conumption of an argument fails

UnconsumedParameterException - thrown if there are too many arguments