com.sdl.context.common.cli

Class Command

java.lang.Object

com.sdl.context.common.cli.Command

public class Command
extends Object

Very simple light weight CLI processing that can be embedded in the bemoko core jar so that CLIs can be run without any external jar dependencies

• "command a b c" => "1"="a", "2"="b", "3"="c"
• "command -ab -c" => flags "a","b" and c are set to true
• "command --ab" => flags "ab" is set to true
• "command --ab=123 -cd=123" => "ab"="123", "cd"="456"

.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Command.CommandException Command exception.

Constructor Summary

Constructors

Constructor and Description
Command(String args) Instantiates a new command.
Command(String[] args) Instantiates a new command.
Command(String[] args, int argIdx) Instantiates a new command.
Command(String underlyingLine, String[] args, Class<?> cliClass, String usage) Instantiates a new command.

Method Summary

Modifier and Type	Method and Description
Command	append(Command command)
Command	append(String lineToAppend)
void	expect(int key) Expect.
String	get(int key) Get.
char	get(int key, char defaultValue) Get.
int	get(int key, int defaultValue) Get.
String	get(int key, String defaultValue) Get.
String	get(String key) Get the given key.
char	get(String key, char defaultValue) Get.
int	get(String key, int defaultValue) Get.
String	get(String key, String defaultValue) Get.
String	getJoinedArgs(int from)
String	getLine() Gets the line.
String	getLine(int startingArgumentIndex) Get the arguments from the given index as a single string.
String	getUnderlyingLine() Get the underlying line as string that led to this command, with any continuation character if there was any.
boolean	has(int key) Has.
boolean	has(String key) Has.
boolean	is(String flag) Is.
boolean	isEmpty()
boolean	isPartialCommand()
int	size() Size.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(String args)

Instantiates a new command.

Parameters:

args - the args

Command

public Command(String[] args)

Instantiates a new command.

Parameters:

args - the args

Command

public Command(String[] args,
               int argIdx)

Instantiates a new command.

Parameters:

args - the args

argIdx - Start index

Command

public Command(String underlyingLine,
               String[] args,
               Class<?> cliClass,
               String usage)

Instantiates a new command.

Parameters:

args - the args

cliClass - the cli class

usage - the usage

Method Detail

getLine

public String getLine()

Gets the line.

Returns:

the line

getUnderlyingLine

public String getUnderlyingLine()

Get the underlying line as string that led to this command, with any continuation character if there was any.

Returns:

underlying line

getLine

public String getLine(int startingArgumentIndex)

Get the arguments from the given index as a single string.

Parameters:

startingArgumentIndex - starting argument index

Returns:

line

append

public Command append(Command command)

append

public Command append(String lineToAppend)

get

public String get(String key)

Get the given key. If the key is set, but not set to anything then this method will return "true"

Parameters:

key - the key

Returns:

the string

get

public String get(String key,
                  String defaultValue)

Get.

Parameters:

key - the key

defaultValue - the default value

Returns:

the string

get

public int get(String key,
               int defaultValue)

Get.

Parameters:

key - the key

defaultValue - the default value

Returns:

the int

get

public char get(String key,
                char defaultValue)

Get.

Parameters:

key - the key

defaultValue - the default value

Returns:

the char

get

public String get(int key)

Get.

Parameters:

key - the key

Returns:

the string

getJoinedArgs

public String getJoinedArgs(int from)

get

public String get(int key,
                  String defaultValue)

Get.

Parameters:

key - the key

defaultValue - the default value

Returns:

the string

get

public int get(int key,
               int defaultValue)

Get.

Parameters:

key - the key

defaultValue - the default value

Returns:

the int

get

public char get(int key,
                char defaultValue)

Get.

Parameters:

key - the key

defaultValue - the default value

Returns:

the char

is

public boolean is(String flag)

Is.

Parameters:

flag - the flag

Returns:

true, if successful

expect

public void expect(int key)

Expect.

Parameters:

key - the key

has

public boolean has(int key)

Has.

Parameters:

key - the key

Returns:

true, if successful

has

public boolean has(String key)

Has.

Parameters:

key - the key

Returns:

true, if successful

size

public int size()

Size.

Returns:

the int

isEmpty

public boolean isEmpty()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

isPartialCommand

public boolean isPartialCommand()