public class ProgramArgumentManager extends Object
Modifier and Type | Class and Description |
---|---|
static class |
ProgramArgumentManager.Argument |
static class |
ProgramArgumentManager.HelpSection |
Constructor and Description |
---|
ProgramArgumentManager(List<String> args)
Enables access to prepared program argument management.
|
ProgramArgumentManager(Object... args)
Enables access to prepared program argument management.
|
ProgramArgumentManager(String args)
Enables access to prepared program argument management.
|
ProgramArgumentManager(String[] args)
Enables access to prepared program argument management.
|
Modifier and Type | Method and Description |
---|---|
ProgramArgumentManager.HelpSection |
createHelpSection() |
ProgramArgumentManager.Argument |
getArgument(String argumentName) |
ProgramArgumentManager.Argument |
getArgumentByOrder(int order) |
String |
getArgumentByOrderAsString(int order) |
String |
getValue(String... alternativeArgumentNames)
Often alternative parameter names for the same argument is used.
|
String |
getValue(String argumentName)
Get value of parameter by its name.
|
boolean |
hasAnyOfTheArguments(String... alternativeArguments)
Often alternative parameter names for the same argument is used.
|
boolean |
hasArgument(String argument)
Check if the argument is registered.
|
int |
numberOfArguments()
Returns a count of the number of arguments found.
|
String |
toString() |
List<ProgramArgumentManager.Argument> |
unusedArguments()
Returns a list of the arguments that has not been marked as used.
|
List<String> |
unusedArgumentsAsStrings() |
String |
use(String... alternativeArgumentNames)
Often alternative parameter names for the same argument is used.
|
String |
use(String argumentName)
Retrieves the value of the argument with the given name, and marks it as used for reference.
|
List<ProgramArgumentManager.Argument> |
usedArguments()
Returns a list of the arguments that has been marked as used.
|
public ProgramArgumentManager(String[] args)
args
- Program argumentspublic ProgramArgumentManager(String args)
args
- Program argumentspublic ProgramArgumentManager(List<String> args)
args
- Program argumentspublic ProgramArgumentManager(Object... args)
args
- Program argumentspublic ProgramArgumentManager.HelpSection createHelpSection()
public ProgramArgumentManager.Argument getArgument(String argumentName)
public ProgramArgumentManager.Argument getArgumentByOrder(int order)
public String getArgumentByOrderAsString(int order)
public String getValue(String argumentName)
argumentName
- The name of the argument to retrieve the value for.public List<ProgramArgumentManager.Argument> unusedArguments()
public List<ProgramArgumentManager.Argument> usedArguments()
public String use(String argumentName)
argumentName
- The name of the argument. Case insensitive.public boolean hasArgument(String argument)
argument
- Argument name, without dashes.public boolean hasAnyOfTheArguments(String... alternativeArguments)
alternativeArguments
- Alternatives to find.public String use(String... alternativeArgumentNames)
alternativeArgumentNames
- Alternatives to find.public String getValue(String... alternativeArgumentNames)
alternativeArgumentNames
- Alternatives to find.public int numberOfArguments()
Copyright © 2018. All rights reserved.