public class AmiParameter
extends java.lang.Object
An AmiParameter name must be a non-null string.
The supported Java primitive types are boolean, byte, sort, int, long, float and double.
The supported Java classes are String, Boolean, and Number class.
Only minimal argument checking is performed in the constructors and other methods of this class. More rigorous validation checks are performed during AmiSession#addMethod(AmiMethodInterface) if and only if the AmiSession's trace level has the AMI_AMI bit turned on.
Constructor and Description |
---|
AmiParameter(java.lang.String name,
boolean value)
Constructor to create an AmiParameter with boolean type.
|
AmiParameter(java.lang.String name,
byte value)
Constructor to create an AmiParameter with byte type.
|
AmiParameter(java.lang.String name,
double value)
Constructor to create an AmiParameter with double type.
|
AmiParameter(java.lang.String name,
float value)
Constructor to create an AmiParameter with float type.
|
AmiParameter(java.lang.String name,
int value)
Constructor to create an AmiParameter with int type.
|
AmiParameter(java.lang.String name,
long value)
Constructor to create an AmiParameter with long type.
|
AmiParameter(java.lang.String name,
java.lang.Object value)
Constructor to create an instance of AmiParameter object.
|
AmiParameter(java.lang.String name,
short value)
Constructor to create an AmiParameter with short type.
|
AmiParameter(java.lang.String name,
java.lang.String help,
boolean value)
Constructor to create an AmiParameter with boolean type
|
AmiParameter(java.lang.String name,
java.lang.String help,
byte value)
Constructor to create an AmiParameter with byte type.
|
AmiParameter(java.lang.String name,
java.lang.String help,
double value)
Constructor to create an AmiParameter with double type.
|
AmiParameter(java.lang.String name,
java.lang.String help,
float value)
Constructor to create an AmiParameter with float type.
|
AmiParameter(java.lang.String name,
java.lang.String help,
int value)
Constructor to create an AmiParameter with int type.
|
AmiParameter(java.lang.String name,
java.lang.String help,
long value)
Constructor to create an AmiParameter with long type.
|
AmiParameter(java.lang.String name,
java.lang.String help,
java.lang.Object value)
Constructor to create an instance of AmiParameter object
|
AmiParameter(java.lang.String name,
java.lang.String help,
short value)
Constructor to create an AmiParameter with sort type.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getHelp()
Returns the help text of the parameter
|
java.lang.Object[] |
getLegalChoices()
Returns an array of legal choices object associated with this AmiParameter
|
java.lang.String |
getName()
Returns the name of this AmiParameter object.
|
java.lang.Object |
getValue()
Returns the sample value object for this AmiParameter object.
|
java.lang.Object[] |
getValueChoices()
Returns an array of value choices object associated with this AmiParameter
|
void |
setLegalChoices(byte[] choices)
Sets the legal choices for this AMI parameter with an array of byte type.
|
void |
setLegalChoices(double[] choices)
Sets the legal choices for this AMI parameter with an array of double type
|
void |
setLegalChoices(float[] choices)
Sets the legal choices for this AMI parameter with an array of float type
|
void |
setLegalChoices(int[] choices)
Sets the legal choices for this AMI parameter with an array of int type
|
void |
setLegalChoices(long[] choices)
Sets the legal choices for this AMI parameter with an array of long type
|
void |
setLegalChoices(java.lang.Object[] choices)
Sets the legal choices for this AMI parameter with an array of Objects.
|
void |
setLegalChoices(short[] choices)
Sets the legal choices for this AMI parameter with an array of short type
|
void |
setValueChoices(byte[] choices)
Sets the value choices for this AMI parameter with an array of byte type.
|
void |
setValueChoices(double[] choices)
Sets the value choices for this AMI parameter with an array of double type
|
void |
setValueChoices(float[] choices)
Sets the value choices for this AMI parameter with an array of float type
|
void |
setValueChoices(int[] choices)
Sets the value choices for this AMI parameter with an array of int type
|
void |
setValueChoices(long[] choices)
Sets the value choices for this AMI parameter with an array of long type
|
void |
setValueChoices(java.lang.Object[] choices)
Sets the value choices for this AMI parameter.
|
void |
setValueChoices(short[] choices)
Sets the value choices for this AMI parameter with an array of short type.
|
java.lang.String |
toString() |
public AmiParameter(java.lang.String name, java.lang.String help, java.lang.Object value)
name
- Name of the parameterhelp
- Help text of the parametervalue
- Value of the parameter.
The supported Java classes for this parameter are String, Boolean
or Number classes.public AmiParameter(java.lang.String name, java.lang.String help, boolean value)
name
- Name of the AMI parameter.help
- Help text of the AMI parameter.value
- This AMI parameter data type is boolean
.
Note that for boolean parameter type, it has the legal choices of
true
or false
.
public AmiParameter(java.lang.String name, java.lang.String help, byte value)
name
- Name of the AMI parameter.help
- Help text of the AMI parameter.value
- This AMI parameter data type is byte
.
public AmiParameter(java.lang.String name, java.lang.String help, short value)
name
- Name of the AMI parameter.help
- Help text of the AMI parameter.value
- This AMI parameter data type is short
.
public AmiParameter(java.lang.String name, java.lang.String help, int value)
name
- Name of the AMI parameter.help
- Help text of the AMI parameter.value
- This AMI parameter data type is int
.
public AmiParameter(java.lang.String name, java.lang.String help, long value)
name
- Name of the AMI parameter.help
- Help text of the AMI parameter.value
- This AMI parameter data type is long
.
public AmiParameter(java.lang.String name, java.lang.String help, float value)
name
- Name of the AMI parameter.help
- Help text of the AMI parameter.value
- This AMI parameter data type is float
.
public AmiParameter(java.lang.String name, java.lang.String help, double value)
name
- Name of the AMI parameter.help
- Help text of the AMI parameter.value
- This AMI parameter data type is double
.
public AmiParameter(java.lang.String name, java.lang.Object value)
name
- Name of the parameter.value
- Value of the parameter.
The supported Java classes for this parameter are String, Boolean
or Number class.public AmiParameter(java.lang.String name, boolean value)
name
- Name of the AMI parameter.value
- This AMI parameter data type is boolean
.
public AmiParameter(java.lang.String name, byte value)
name
- Name of the AMI parameter.value
- This AMI parameter data type is byte
.
public AmiParameter(java.lang.String name, short value)
name
- Name of the AMI parameter.value
- This AMI parameter data type is short
.
public AmiParameter(java.lang.String name, int value)
name
- Name of the AMI parameter.value
- This AMI parameter data type is int
.
public AmiParameter(java.lang.String name, long value)
name
- Name of the AMI parameter.value
- This AMI parameter data type is long
.
public AmiParameter(java.lang.String name, float value)
name
- Name of the AMI parameter.value
- This AMI parameter data type is float
.
public AmiParameter(java.lang.String name, double value)
name
- Name of the AMI parameter.value
- This AMI parameter data type is double
.
public java.lang.String getName()
public java.lang.String getHelp()
public java.lang.Object getValue()
public java.lang.Object[] getLegalChoices()
public java.lang.Object[] getValueChoices()
public void setLegalChoices(java.lang.Object[] choices)
choices
- an array of legal choices objects
The supported Java classes for this parameter are array of String, Boolean or Number classes. No error checking in this method.
public void setLegalChoices(byte[] choices)
choices
- - Array of byte choices.public void setLegalChoices(short[] choices)
choices
- - Array of choices.public void setLegalChoices(int[] choices)
choices
- - Array of choices.public void setLegalChoices(long[] choices)
choices
- - Array of choices.public void setLegalChoices(float[] choices)
choices
- - Array of choices.public void setLegalChoices(double[] choices)
choices
- - Array of choices.public void setValueChoices(java.lang.Object[] choices)
choices
- an array of value choices objectspublic void setValueChoices(byte[] choices)
choices
- - Array of choices.public void setValueChoices(short[] choices)
choices
- - Array of choices.public void setValueChoices(int[] choices)
choices
- - Array of choices.public void setValueChoices(long[] choices)
choices
- - Array of choices.public void setValueChoices(float[] choices)
choices
- - Array of choices.public void setValueChoices(double[] choices)
choices
- - Array of choices.public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2000-2019 TIBCO Inc. All Rights Reserved.