Top Description Fields Constructors Methods
org.apache.tomcat.util.descriptor.web

public Class MessageDestinationRef

extends ResourceBase
Class Inheritance

Representation of a message destination reference for a web application, as represented in a <message-destination-ref> element in the deployment descriptor.

Author
Craig R. McClanahan
Since
Tomcat 5.0

Field Summary

Modifier and TypeField and Description
private String
link

The link of this destination ref.

private static final long
private String
usage

The usage of this destination ref.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.equals.

Indicates whether some other object is "equal to" this one.

public String
public int
hashCode()

Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.hashCode.

Returns a hash code value for this object.

public void
public String
toString()

Overrides java.lang.Object.toString.

Return a String representation of this object.

Inherited from org.apache.tomcat.util.descriptor.web.ResourceBase:
addInjectionTargetgetDescriptiongetInjectionTargetsgetLookupNamegetNamegetNamingResourcesgetPropertygetTypelistPropertiesremovePropertysetDescriptionsetLookupNamesetNamesetNamingResourcessetPropertysetType

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.apache.tomcat.util.descriptor.web.ResourceBase.serialVersionUID.

usageback to summary
private String usage

The usage of this destination ref.

Constructor Detail

MessageDestinationRefback to summary
public MessageDestinationRef()

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getUsageback to summary
public String getUsage()
hashCodeback to summary
public int hashCode()

Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
setUsageback to summary
public void setUsage(String usage)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Return a String representation of this object.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations
@Override