Top Description Fields Constructors Methods
com.sun.tools.xjc.api

public final Class Reference

extends Object
Class Inheritance
Annotations
@Deprecated
since:4.0
forRemoval:true
@SuppressWarnings:exports
Imports
javax.annotation.processing.ProcessingEnvironment, javax.lang.model.element.Element, .ExecutableElement, .TypeElement, .VariableElement, javax.lang.model.type.TypeMirror

Deprecated

for removal since 4.0.

Use com.sun.tools.jxc.api.Reference instead.

Reference to a JAXB type (from JAX-RPC.)

A reference is a Java type (represented as a TypeMirror) and a set of annotations (represented as a Element). Together they describe a root reference to a JAXB type binding.

Those two values can be supplied independently, or you can use other convenience constructors to supply two values at once.

Author
Kohsuke Kawaguchi

Field Summary

Modifier and TypeField and Description
public final Element
annotations

The declaration from which annotations for the type is read.

public final TypeMirror
type

The JAXB type being referenced.

Constructor Summary

AccessConstructor and Description
public
Reference(ExecutableElement method)

Creates a reference from the return type of the method and annotations on the method.

public
Reference(VariableElement param)

Creates a reference from the parameter type and annotations on the parameter.

public
Reference(TypeElement type, ProcessingEnvironment env)

Creates a reference from a class declaration and its annotations.

public
Reference(TypeMirror type, Element annotations)

Creates a reference by providing two values independently.

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.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

annotationsback to summary
public final Element annotations

The declaration from which annotations for the type is read. Must not be null.

typeback to summary
public final TypeMirror type

The JAXB type being referenced. Must not be null.

Constructor Detail

Referenceback to summary
public Reference(ExecutableElement method)

Creates a reference from the return type of the method and annotations on the method.

Referenceback to summary
public Reference(VariableElement param)

Creates a reference from the parameter type and annotations on the parameter.

Referenceback to summary
public Reference(TypeElement type, ProcessingEnvironment env)

Creates a reference from a class declaration and its annotations.

Referenceback to summary
public Reference(TypeMirror type, Element annotations)

Creates a reference by providing two values independently.

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