|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.websphere.brb.mgmt.ConstantParameter
A constant parameter.
Constructor Summary | |
ConstantParameter(java.lang.Object constant)
Creates an IParameter for passing a constant as a parameter. |
Method Summary | |
boolean |
equals(java.lang.Object obj)
Determine if this object is equal to the object passed in. |
java.lang.Object |
getConstant()
Returns the constant which is returned when getValue is invoked. |
java.lang.String |
getUserDescription()
Returns the user's description of this parameter. |
java.lang.Object |
getValue(java.lang.Object[] tpFiringParams,
java.lang.Object target)
Gets the value that this parameter represents. |
java.lang.String |
getValueDescription()
Returns the text description of the value of this parameter. |
IParameter |
makeCopy()
Makes a copy of this object. |
void |
setUserDescription(java.lang.String newUserDescription)
Sets the user-specified description of this parameter. |
java.lang.String |
toXML(boolean format,
java.lang.String indent)
Returns the XML representation of this IParameter. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ConstantParameter(java.lang.Object constant)
IParameter
for passing a constant as a parameter. It is not allowed to
pass an arbitrary Serializable type as the constant. Only the following types are supported:
constant
- the value getValue
will returnMethod Detail |
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.Object getConstant()
getValue
is invoked.public java.lang.String getUserDescription()
IParameter
getUserDescription
in interface IParameter
com.ibm.websphere.brb.mgmt.IParameter
public java.lang.Object getValue(java.lang.Object[] tpFiringParams, java.lang.Object target)
IParameter
getValue
in interface IParameter
com.ibm.websphere.brb.mgmt.IParameter
tpFiringParams
- the firing parameters passed from the trigger pointtarget
- the target object passed from the trigger pointpublic java.lang.String getValueDescription()
IParameter
getValueDescription
in interface IParameter
com.ibm.websphere.brb.mgmt.IParameter
public IParameter makeCopy()
makeCopy
in interface IParameter
public void setUserDescription(java.lang.String newUserDescription)
IParameter
setUserDescription
in interface IParameter
com.ibm.websphere.brb.mgmt.IParameter
newUserDescription
- the new description of this parameterpublic java.lang.String toXML(boolean format, java.lang.String indent)
IParameter
format
indicates whether the
XML should be formatted with indentation and new lines.
Parameter indent
specifies the number of
characters to indent the XML. This value is ignored
if false
is given for parameter
format
.toXML
in interface IParameter
com.ibm.websphere.brb.mgmt.IParameter
format
- boolean indicating whether XML should be formattedindent
- the String to use to indent the XML
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |