|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.websphere.brb.mgmt.TriggerPointParameter
A parameter which is retrieved from one of the trigger point firing parameters.
Constructor Summary | |
---|---|
TriggerPointParameter(int sourcePosition)
Creates an IParameter which returns the parameter from the given position in the TriggerPoint firing parameters when getValue is called. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
Determine if this object is equal to the object passed in. |
int |
getSourcePosition()
Returns the zero-based position of the given parameter which this IParameter will return. |
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 |
toShortenedXML()
Returns a shortened XML representation of this IParameter. |
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 TriggerPointParameter(int sourcePosition)
getValue
is called.
sourcePosition
- the position of the input array to copy the parameter fromMethod Detail |
public boolean equals(java.lang.Object obj)
public int getSourcePosition()
public java.lang.String getUserDescription()
IParameter
getUserDescription
in interface IParameter
public java.lang.Object getValue(java.lang.Object[] tpFiringParams, java.lang.Object target)
IParameter
getValue
in interface IParameter
tpFiringParams
- the firing parameters passed from the trigger pointtarget
- the target object passed from the trigger point
public java.lang.String getValueDescription()
IParameter
getValueDescription
in interface IParameter
public IParameter makeCopy()
makeCopy
in interface IParameter
public void setUserDescription(java.lang.String newUserDescription)
IParameter
setUserDescription
in interface 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
format
- boolean indicating whether XML should be formattedindent
- the String to use to indent the XML
public java.lang.String toShortenedXML()
IParameter
FOR IBM INTERNAL USE ONLY
toShortenedXML
in interface IParameter
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |