Top Description Fields Constructors Methods
org.glassfish.jaxb.runtime.api

public final Class TypeReference

extends Object
Class Inheritance
Imports
javax.xml.namespace.QName, java.lang.annotation.Annotation, java.lang.reflect.Type, java.util.Arrays, .Collection

A reference to a JAXB-bound type.

Subject to change without notice.

Author
Kohsuke Kawaguchi
Since
2.0 EA1

Field Summary

Modifier and TypeField and Description
public final Annotation[]
annotations

The annotations associated with the reference of this type.

public final QName
tagName

The associated XML element name that the JAX-RPC uses with this type reference.

public final Type
type

The Java type that's being referenced.

Constructor Summary

AccessConstructor and Description
public
TypeReference(QName tagName, Type type, Annotation... annotations)

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 <A extends Annotation> A
get(Class<A> annotationType)

Finds the specified annotation from the array and returns it.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public TypeReference
toItemType()

Creates a for the item type, if this represents a collection type.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

annotationsback to summary
public final Annotation[] annotations

The annotations associated with the reference of this type. Always non-null.

tagNameback to summary
public final QName tagName

The associated XML element name that the JAX-RPC uses with this type reference. Always non-null. Strings are interned.

typeback to summary
public final Type type

The Java type that's being referenced. Always non-null.

Constructor Detail

TypeReferenceback to summary
public TypeReference(QName tagName, Type type, Annotation... annotations)

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
getback to summary
public <A extends Annotation> A get(Class<A> annotationType)

Finds the specified annotation from the array and returns it. Null if not found.

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
toItemTypeback to summary
public TypeReference toItemType()

Creates a for the item type, if this represents a collection type. Otherwise returns an identical type.