Top Description Fields Constructors Methods
org.jvnet.hk2.internal

public Class CacheKey

extends Object
Class Inheritance
Imports
java.lang.annotation.Annotation, java.lang.reflect.Type, java.security.AccessController, .PrivilegedAction, org.glassfish.hk2.api.Unqualified, org.glassfish.hk2.utilities.general.GeneralUtilities, org.glassfish.hk2.utilities.reflection.Pretty, .ReflectionHelper
This is the cache key, which encapsulates very specific lookup queries. The point of this is to be useable as the key in a hash map, so that equals and hashCode must work properly
Author
jwells

Field Summary

Modifier and TypeField and Description
private final int
hashCode

Pre-calculated in order to improve hashMap lookups

private final Type
lookupType

private final String
name

private final Annotation[]
qualifiers

private final String
removalName

private final Unqualified
unqualified

Constructor Summary

AccessConstructor and Description
public
CacheKey(Type
The type in the lookup call
lookupType, String
The name in the lookup call
name, Unqualified unqualified, Annotation...
The set of qualifiers being looked up
qualifiers)

Key used for LRU cache

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object o)

Overrides java.lang.Object.equals.

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

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean

Returns:

true if this CacheKey is associated with the name contract, and should thus be removed
matchesRemovalName(String
The name of the contract that has been removed from the system
name)

Used when bulk removing a contract that has been removed from the system

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

hashCodeback to summary
private final int hashCode

Pre-calculated in order to improve hashMap lookups

lookupTypeback to summary
private final Type lookupType
nameback to summary
private final String name
qualifiersback to summary
private final Annotation[] qualifiers
removalNameback to summary
private final String removalName
unqualifiedback to summary
private final Unqualified unqualified

Constructor Detail

CacheKeyback to summary
public CacheKey(Type lookupType, String name, Unqualified unqualified, Annotation... qualifiers)

Key used for LRU cache

Parameters
lookupType:Type

The type in the lookup call

name:String

The name in the lookup call

qualifiers:Annotation[]

The set of qualifiers being looked up

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.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.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.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.
Annotations
@Override
matchesRemovalNameback to summary
public boolean matchesRemovalName(String name)

Used when bulk removing a contract that has been removed from the system

Parameters
name:String

The name of the contract that has been removed from the system

Returns:boolean

true if this CacheKey is associated with the name contract, and should thus be removed

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.