Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.derby.impl.services.monitor
Class ProtocolKey  view ProtocolKey download ProtocolKey.java

java.lang.Object
  extended byorg.apache.derby.impl.services.monitor.ProtocolKey

class ProtocolKey
extends java.lang.Object

A class that represents a key for a module search.


Field Summary
protected  java.lang.Class factoryInterface
          The class of the factory
protected  java.lang.String identifier
          name of module, can be null
 
Constructor Summary
protected ProtocolKey(java.lang.Class factoryInterface, java.lang.String identifier)
           
 
Method Summary
(package private) static ProtocolKey create(java.lang.String className, java.lang.String identifier)
           
 boolean equals(java.lang.Object other)
          Determine whether this Object is semantically equal to another Object.
protected  java.lang.Class getFactoryInterface()
           
protected  java.lang.String getIdentifier()
           
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

factoryInterface

protected java.lang.Class factoryInterface
The class of the factory


identifier

protected java.lang.String identifier
name of module, can be null

Constructor Detail

ProtocolKey

protected ProtocolKey(java.lang.Class factoryInterface,
                      java.lang.String identifier)
Method Detail

create

static ProtocolKey create(java.lang.String className,
                          java.lang.String identifier)
                   throws org.apache.derby.iapi.error.StandardException

getFactoryInterface

protected java.lang.Class getFactoryInterface()

getIdentifier

protected java.lang.String getIdentifier()

hashCode

public int hashCode()
Description copied from class: java.lang.Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)


equals

public boolean equals(java.lang.Object other)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.


toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).