Package org.jppf.utils.cli

Class PositionalArguments

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

org.jppf.utils.AbstractTypedProperties

org.jppf.utils.TypedProperties

org.jppf.utils.cli.PositionalArguments

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class PositionalArguments
extends TypedProperties

Author:

Laurent Cohen

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jppf.utils.TypedProperties

TypedProperties.Filter

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor	Description
PositionalArguments()

Method Summary

Modifier and Type	Method	Description
PositionalArguments	addArg(String name, String usage)	Add a new argument with an explicit value.
String	getString(int position)	Get the value of the argument at the specified position.
String	getTitle()	Get the title diaplayed in the printUsage() method.
PositionalArguments	parseArguments(String... clArgs)	Parse the specified command line arguments.
PositionalArguments	printUsage()	Print usage of the arguments.
PositionalArguments	setTitle(String title)	Set the title diaplayed in the printUsage() method.
String	toString()

Methods inherited from class org.jppf.utils.TypedProperties

containsProperty, filter, get, get, getBoolean, getBoolean, getChar, getChar, getDouble, getDouble, getFile, getFile, getFloat, getFloat, getInetAddress, getInetAddress, getInt, getInt, getLong, getLong, getProperties, getProperties, getString, getString, getStringArray, getStringArray, remove, remove, removeProperty, set, set, setBoolean, setChar, setDouble, setFile, setFloat, setInt, setLong, setString, setStringArray, store

Methods inherited from class org.jppf.utils.AbstractTypedProperties

asString, asString, fromString, fromString, getDefaults, loadAndResolve, reset, setDefaults

Methods inherited from class java.util.Properties

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, getProperty, getProperty, hashCode, isEmpty, keys, keySet, list, list, load, load, loadFromXML, merge, propertyNames, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, save, setProperty, size, store, storeToXML, storeToXML, storeToXML, stringPropertyNames, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PositionalArguments

public PositionalArguments()

Method Details

printUsage

public PositionalArguments printUsage()

Print usage of the arguments.

Returns:

this object.

parseArguments

public PositionalArguments parseArguments(String... clArgs)
                                   throws Exception

Parse the specified command line arguments.

Parameters:

clArgs - the arguments to parse.

Returns:

this object.

Throws:

Exception - if any error occurs.

getString

public String getString(int position)

Get the value of the argument at the specified position.

Parameters:

position - the posiiton of the argument ot lookup.

Returns:

the argument value, or null if it is not found.

addArg

public PositionalArguments addArg(String name,
 String usage)

Add a new argument with an explicit value.

Parameters:

name - the name of the argument.

usage - a string describing the argument's usage.

Returns:

return this object.

getTitle

public String getTitle()

Get the title diaplayed in the printUsage() method.

Returns:

the title as a string.

setTitle

public PositionalArguments setTitle(String title)

Set the title diaplayed in the printUsage() method.

Parameters:

title - the title as a string.

Returns:

this object.

toString

public String toString()

Overrides:

toString in class AbstractTypedProperties