public static class GCTP.Requirements
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static int |
MAX_PARAMETERS
The maximum number of requirement parameters.
|
Constructor and Description |
---|
Requirements(java.lang.String[] list)
Creates a new requirements object from the specified list.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDescription(int index)
Gets the requirement description for the specified parameter
index.
|
int |
getParameters()
Gets the total number of required parameters.
|
java.lang.String |
getShortDescription(int index)
Gets the requirement short description for the specified
parameter index.
|
java.lang.String |
getUnits(int index)
Gets the requirement units for the specified parameter
index.
|
boolean |
isRequired(int index)
Determines if the specified parameter is required.
|
public static final int MAX_PARAMETERS
public Requirements(java.lang.String[] list)
GCTP.getRequirements(int)
method.list
- the array of requirements as descriptive strings.
The array may contain empty string values for unrequired
parameters indices. If the length of the array is less than
the maximum number of required parameters, the remaining
parameters are assumed to be unrequired.public boolean isRequired(int index)
index
- the parameter index in the range
[0..MAX_PARAMETERS-1].public java.lang.String getShortDescription(int index)
index
- the parameter index in the range
[0..MAX_PARAMETERS-1].public java.lang.String getDescription(int index)
index
- the parameter index in the range
[0..MAX_PARAMETERS-1].public java.lang.String getUnits(int index)
index
- the parameter index in the range
[0..MAX_PARAMETERS-1].public int getParameters()