de.smartics.exceptions.report.message
Class PlaceHolderDescId

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

All Implemented Interfaces:

Serializable, Comparable< PlaceHolderDescId>

public final class PlaceHolderDescId
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      Serializable, 
      
      Comparable<
      
      PlaceHolderDescId>
     
     

Identifies a place holder description by its index an message type.

Author:

Robert Reiner

See Also:

Serialized Form

Constructor Summary

PlaceHolderDescId(int placeHolderIndex)
Convenience constructor for a place holder for any message type.

PlaceHolderDescId(int placeHolderIndex, MessageType messageType)
Default constructor.

Method Summary

int	compareTo(PlaceHolderDescId o)
boolean	equals(Object object) Returns true if the given object is semantically equal to the given object, false otherwise.
MessageType	getMessageType() Returns the type of the indexed message.
int	getPlaceHolderIndex() Returns the index of the place holder within a message of the given message type.
int	hashCode() Returns the hash code of the object.
String	toString() Returns the string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PlaceHolderDescId

public PlaceHolderDescId(int placeHolderIndex)
                  throws NullPointerException

Convenience constructor for a place holder for any message type.

Parameters:

placeHolderIndex - the index of the place holder within any message.

Throws:

NullPointerException - if placeHolderIndexis null.

PlaceHolderDescId

public PlaceHolderDescId(int placeHolderIndex,
                         MessageType messageType)

Default constructor.

Parameters:

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

messageType - the type of the indexed message.

Method Detail

getPlaceHolderIndex

public int 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.

getMessageType

public MessageType getMessageType()

Returns the type of the indexed message.

Returns:

the type of the indexed message.

hashCode

public int hashCode()

Returns the hash code of the object.

Overrides:

hashCode in class Object

Returns:

the hash code.

equals

public boolean equals(Object object)

Returns true if the given object is semantically equal to the given object, false otherwise.

Overrides:

equals in class Object

Parameters:

object - the instance to compare to.

Returns:

true if the given object is semantically equal to the given object, false otherwise.

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string representation of the object.

compareTo

public int compareTo(PlaceHolderDescId o)

Specified by:

compareTo in interface Comparable<PlaceHolderDescId>

See Also:

Comparable.compareTo(java.lang.Object)