de.smartics.exceptions.report.message
Class PlaceHolderDesc

java.lang.Object
  de.smartics.exceptions.report.message.PlaceHolderDesc

All Implemented Interfaces:

Serializable, Comparable< PlaceHolderDesc>

public final class PlaceHolderDesc
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      Serializable, 
      
      Comparable<
      
      PlaceHolderDesc>
     
     

Information about a place holder.

See Also:

Serialized Form

Constructor Summary

PlaceHolderDesc(PlaceHolderDescId placeHolderId, String paramName, String ognlPath, String description)
Default constructor.

PlaceHolderDesc(PlaceHolderDesc desc, MessageType messageType)
Copy constructor with a new message type.

Method Summary

int	compareTo(PlaceHolderDesc o)
String	getDescription() Returns the description of the place holder.
String	getOgnlPath() Returns the path to the value that substitutes the place holder.
String	getParamName() Returns the descriptive name of the place holder.
PlaceHolderDescId	getPlaceHolderId() Returns the ID of the place holder.
String	getPlaceHolderIndex() Returns the index of the place holder within a message of the given message type.
MessageType	getPlaceHolderMessageType() Returns the type of the indexed message.
String	toString() Returns the string representation of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PlaceHolderDesc

public PlaceHolderDesc(PlaceHolderDesc desc,
                       MessageType messageType)

Copy constructor with a new message type.

Parameters:

desc - the description to copy except its message type.

messageType - the new message type.

PlaceHolderDesc

public PlaceHolderDesc(PlaceHolderDescId placeHolderId,
                       String paramName,
                       String ognlPath,
                       String description)

Default constructor.

Parameters:

placeHolderId - the ID of the place holder.

paramName - the descriptive name of the place holder.

ognlPath - the path to the value that substitutes the place holder.

description - the description of the place holder.

Method Detail

getPlaceHolderId

public PlaceHolderDescId getPlaceHolderId()

Returns the ID of the place holder.

Returns:

the ID of the place holder.

getPlaceHolderIndex

public String getPlaceHolderIndex()

Returns the index of the place holder within a message of the given message type.

Returns:

the index of the place holder within a message of the given message type.

getPlaceHolderMessageType

public MessageType getPlaceHolderMessageType()

Returns the type of the indexed message.

Returns:

the type of the indexed message.

getParamName

public String getParamName()

Returns the descriptive name of the place holder. This is the name of the field that holds the value. The value may be a complex type where the OGNL path points to the value of the variable that will substitute the place holder.

Returns:

the descriptive name of the place holder.

getOgnlPath

public String getOgnlPath()

Returns the path to the value that substitutes the place holder.

Returns:

the path to the value that substitutes the place holder.

getDescription

public String getDescription()

Returns the description of the place holder.

Returns:

the description of the place holder.

compareTo

public int compareTo(PlaceHolderDesc o)

Specified by:

compareTo in interface Comparable<PlaceHolderDesc>

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string representation of the object.