com.sk89q.intake.parametric

Class ArgumentParser

java.lang.Object

com.sk89q.intake.parametric.ArgumentParser

public final class ArgumentParser
extends Object

An argument parser takes in a list of tokenized arguments and parses them, converting them into appropriate Java objects using a provided Injector.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArgumentParser.Builder Builds instances of ArgumentParser.

Method Summary

Modifier and Type	Method and Description
List<Parameter>	getUserParameters() Get a list of parameters that are user-provided and not provided.
Set<Character>	getValueFlags() Get a list of value flags that have been requested by the parameters.
Object[]	parseArguments(CommandArgs args) Parse the given arguments into Java objects.
Object[]	parseArguments(CommandArgs args, boolean ignoreUnusedFlags, Set<Character> unusedFlags) Parse the given arguments into Java objects.

Methods inherited from class java.lang.Object

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

Method Detail

getUserParameters

public List<Parameter> getUserParameters()

Get a list of parameters that are user-provided and not provided.

Returns:

A list of user parameters

getValueFlags

public Set<Character> getValueFlags()

Get a list of value flags that have been requested by the parameters.

Returns:

A list of value flags

parseArguments

public Object[] parseArguments(CommandArgs args)
                        throws ArgumentException,
                               ProvisionException

Parse the given arguments into Java objects.

Parameters:

args - The tokenized arguments

Returns:

The list of Java objects

Throws:

ArgumentException - If there is a problem with the provided arguments

ProvisionException - If there is a problem with the binding itself

parseArguments

public Object[] parseArguments(CommandArgs args,
                               boolean ignoreUnusedFlags,
                               Set<Character> unusedFlags)
                        throws ArgumentException,
                               ProvisionException

Parse the given arguments into Java objects.

Parameters:

args - The tokenized arguments

ignoreUnusedFlags - Whether unused flags should not throw an exception

unusedFlags - List of flags that can be unconsumed

Returns:

The list of Java objects

Throws:

ArgumentException - If there is a problem with the provided arguments

ProvisionException - If there is a problem with the binding itself