hk2 4.0.1 · org.glassfish.hk2.api.TypeLiteral · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private transient Class<T>	rawType Store the actual raw parameter type.
private transient Type	type Store the actual type (direct subclass of TypeLiteral).

Access	Constructor and Description
protected	TypeLiteral()

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final Type[]	Returns: A non-null (but possibly empty) array of types associated with this literal getParameterTypes() Gets the types associated with this literal
public final Class<T>	getRawType() Returns: the raw type represented by this object
public static Class<?>	Returns: The base class for the type, or null if there is none (e.g., Wildcard) getRawType(Type The non-null type to analyze type) Gets the base associated class from this type
public final Type	getType() Returns: the actual type represented by this object
private static Class<?>	getTypeLiteralSubclass(Class<?> processed class clazz) Return the direct child class that extends TypeLiteral<t>
private static Type	Returns: the parametrized type of TypeLiteral (aka T) getTypeParameter(Class<?> subClass of TypeLiteral to analyze typeLiteralSubclass) Return the value of the type parameter of TypeLiteral<t>.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

rawType	back to summary
private transient Class<T> rawType Store the actual raw parameter type.

type	back to summary
private transient Type type Store the actual type (direct subclass of TypeLiteral).

TypeLiteral	back to summary
protected TypeLiteral()

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) 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

public boolean equals(Object obj)

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

getParameterTypes	back to summary
public final Type[] getParameterTypes() Gets the types associated with this literal Returns:Type[] A non-null (but possibly empty) array of types associated with this literal

getParameterTypes

back to summary

public final Type[] getParameterTypes()

Gets the types associated with this literal

Returns:Type[]: A non-null (but possibly empty) array of types associated with this literal

getRawType	back to summary
public final Class<T> getRawType() Returns:Class<T> the raw type represented by this object Annotations @SuppressWarnings:unchecked

getRawType	back to summary
public static Class<?> getRawType(Type type) Gets the base associated class from this type Parameters type:Type The non-null type to analyze Returns:Class<?> The base class for the type, or null if there is none (e.g., Wildcard)

getRawType

back to summary

public static Class<?> getRawType(Type type)

Gets the base associated class from this type

Parameters

type:Type: The non-null type to analyze

Returns:Class<?>

The base class for the type, or null if there is none (e.g., Wildcard)

getType	back to summary
public final Type getType() Returns:Type the actual type represented by this object

getTypeLiteralSubclass	back to summary
private static Class<?> getTypeLiteralSubclass(Class<?> clazz) Return the direct child class that extends TypeLiteral Parameters clazz:Class<?> processed class

getTypeLiteralSubclass

back to summary

private static Class<?> getTypeLiteralSubclass(Class<?> clazz)

Return the direct child class that extends TypeLiteral

Parameters

clazz:Class<?>: processed class

getTypeParameter	back to summary
private static Type getTypeParameter(Class<?> typeLiteralSubclass) Return the value of the type parameter of TypeLiteral. Parameters typeLiteralSubclass:Class<?> subClass of TypeLiteral to analyze Returns:Type the parametrized type of TypeLiteral (aka T)

getTypeParameter

back to summary

private static Type getTypeParameter(Class<?> typeLiteralSubclass)

Return the value of the type parameter of TypeLiteral.

Parameters

typeLiteralSubclass:Class<?>: subClass of TypeLiteral to analyze

Returns:Type

the parametrized type of TypeLiteral (aka T)

hashCode back to summary

hashCode	back 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

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

toString back to summary

toString	back 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. Annotations @Override

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.

Annotations

@Override

public abstract Class TypeLiteral<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail