Package org.apache.hadoop.fs.shell

Class CommandFormat

java.lang.Object

org.apache.hadoop.fs.shell.CommandFormat

public class CommandFormat
extends java.lang.Object

Parse the args of a command and check the format of args.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandFormat.DuplicatedOptionException	Used when a duplicated option is supplied to a command.
static class	CommandFormat.IllegalNumberOfArgumentsException	Used when the arguments exceed their bounds
static class	CommandFormat.NotEnoughArgumentsException	Used when too few arguments are supplied to a command
static class	CommandFormat.TooManyArgumentsException	Used when too many arguments are supplied to a command
static class	CommandFormat.UnknownOptionException	Used when an unsupported option is supplied to a command

Constructor Summary

Constructors

Constructor	Description
CommandFormat(int min, int max, java.lang.String... possibleOpt)	Simple parsing of command line arguments
CommandFormat(java.lang.String name, int min, int max, java.lang.String... possibleOpt)	Deprecated. use replacement since name is an unused parameter

Method Summary

Modifier and Type	Method	Description
void	addOptionWithValue(java.lang.String option)	add option with value
boolean	getOpt(java.lang.String option)	Return if the option is set or not
java.util.Set<java.lang.String>	getOpts()	Returns all the options that are set
java.lang.String	getOptValue(java.lang.String option)	get the option's value
java.util.List<java.lang.String>	parse(java.lang.String[] args, int pos)	Parse parameters starting from the given position Consider using the variant that directly takes a List
void	parse(java.util.List<java.lang.String> args)	Parse parameters from the given list of args.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandFormat

@Deprecated
public CommandFormat(java.lang.String name,
                     int min,
                     int max,
                     java.lang.String... possibleOpt)

Deprecated.

use replacement since name is an unused parameter

Parameters:

name - of command, but never used

min - see replacement

max - see replacement

possibleOpt - see replacement

See Also:

CommandFormat(int, int, String...)

CommandFormat

public CommandFormat(int min,
                     int max,
                     java.lang.String... possibleOpt)

Simple parsing of command line arguments

Parameters:

min - minimum arguments required

max - maximum arguments permitted

possibleOpt - list of the allowed switches

Method Detail

addOptionWithValue

public void addOptionWithValue(java.lang.String option)

add option with value

Parameters:

option - option name

parse

public java.util.List<java.lang.String> parse(java.lang.String[] args,
                                              int pos)

Parse parameters starting from the given position Consider using the variant that directly takes a List

Parameters:

args - an array of input arguments

pos - the position at which starts to parse

Returns:

a list of parameters

parse

public void parse(java.util.List<java.lang.String> args)

Parse parameters from the given list of args. The list is destructively modified to remove the options.

Parameters:

args - as a list of input arguments

getOpt

public boolean getOpt(java.lang.String option)

Return if the option is set or not

Parameters:

option - String representation of an option

Returns:

true is the option is set; false otherwise

getOptValue

public java.lang.String getOptValue(java.lang.String option)

get the option's value

Parameters:

option - option name

Returns:

option value if option exists, but no value assigned, return "" if option not exists, return null

getOpts

public java.util.Set<java.lang.String> getOpts()

Returns all the options that are set

Returns:

Set<String> of the enabled options