public class ParameterRef extends java.lang.Object implements java.io.Serializable, LocalisedString
SystemDataConsumers.
These parameters are usually
node parameters,
but parameter references may be used in other contexts as well.
Instances of this class are usually created by one of the utility methods
provided by SystemDataTools.
| Modifier and Type | Field and Description |
|---|---|
protected ProcessConstants.AdeptDataType |
dataType
The data type of the referenced parameter.
|
protected java.lang.String |
name
The name of the referenced parameter.
|
protected java.lang.String |
udtName
The name of the UDT or
null in case it is not a UDT. |
| Modifier | Constructor and Description |
|---|---|
|
ParameterRef(ProcessConstants.AdeptDataType dataType,
java.lang.String name)
Creates a new parameter reference for a parameter of arbitrary data type
except
ProcessConstants.AdeptDataType.USERDEFINED. |
|
ParameterRef(java.lang.String name,
ProcessConstants.AdeptDataType dataType,
java.lang.String udtName)
Constructs a new
ParameterRef with the specified name, data type
and name of UDT. |
protected |
ParameterRef(java.lang.String name,
ProcessConstants.AdeptDataType dataType,
java.lang.String udtName,
boolean discriminator)
Constructs a new
ParameterRef with the specified name, data type
and name of UDT. |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
ProcessConstants.AdeptDataType |
getDataType()
Returns the data type of the referenced parameter.
|
java.lang.String |
getName()
Returns the name of the referenced parameter.
|
java.lang.String |
getUdtName()
The name of the user-defined type or
null in case the
parameter is not of user-defined type ore the name is not defined. |
int |
hashCode() |
java.lang.String |
toLocalisedString(LocalisationFactory locFac,
java.util.Locale loc)
Gets the localised representation of the implementing object.
|
java.lang.String |
toString()
Returns a string of the form
%<typeId>:<parameterName>% as
specified in
SystemDataConsumer. |
protected final java.lang.String name
protected final ProcessConstants.AdeptDataType dataType
protected final java.lang.String udtName
null in case it is not a UDT.public ParameterRef(ProcessConstants.AdeptDataType dataType, java.lang.String name)
ProcessConstants.AdeptDataType.USERDEFINED.dataType - The type of the parameter of this reference.name - The name of the parameter of this reference. This must not be
null.public ParameterRef(java.lang.String name,
ProcessConstants.AdeptDataType dataType,
java.lang.String udtName)
ParameterRef with the specified name, data type
and name of UDT.name - The name of the referenced parameter. This must not be
null or an empty or blank string.dataType - The data type of the referenced parameter.udtName - The name of the UDT in case it is a UDT and the name is
known, null otherwise.protected ParameterRef(java.lang.String name,
ProcessConstants.AdeptDataType dataType,
java.lang.String udtName,
boolean discriminator)
ParameterRef with the specified name, data type
and name of UDT.name - The name of the referenced parameter. Subclasses can provide
null.dataType - The data type of the referenced parameter.udtName - The name of the UDT in case it is a UDT and the name is
known, null otherwise.discriminator - An unused parameter to discriminate
#ParameterRef(String, AdeptDataType, String).public java.lang.String getName()
public ProcessConstants.AdeptDataType getDataType()
public java.lang.String getUdtName()
null in case the
parameter is not of user-defined type ore the name is not defined.null.public java.lang.String toString()
%<typeId>:<parameterName>% as
specified in
SystemDataConsumer.toString in class java.lang.Objectpublic java.lang.String toLocalisedString(LocalisationFactory locFac, java.util.Locale loc)
LocalisedStringLocalised should use the designated
localisation factory for automatic localisation.toLocalisedString in interface LocalisedStringlocFac - The localisation factory to be used by Localised model objects. If this
is null, do not localise the used Localised attributes.loc - The locale for which to get the localised string. If this is null,
treat it like Locale.ROOT has been requested.public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object