Top Description Fields Constructors Methods
org.droidparts.dexmaker.dx.rop.annotation

public final Class Annotation

extends MutabilityControl
implements Comparable<Annotation>, ToHuman
Class Inheritance
All Implemented Interfaces
org.droidparts.dexmaker.dx.util.ToHuman, java.lang.Comparable
Imports
org.droidparts.dexmaker.dx.rop.cst.CstString, .CstType, org.droidparts.dexmaker.dx.util.MutabilityControl, .ToHuman, java.util.Collection, .Collections, .Iterator, .TreeMap
An annotation on an element of a class. Annotations have an associated type and additionally consist of a set of (name, value) pairs, where the names are unique.

Field Summary

Modifier and TypeField and Description
private final TreeMap<CstString, NameValuePair>
elements

non-null; map from names to NameValuePair instances

private final CstType
type

non-null; type of the annotation

private final AnnotationVisibility
visibility

non-null; the visibility of the annotation

Constructor Summary

AccessConstructor and Description
public
Annotation(CstType
non-null; type of the annotation
type, AnnotationVisibility
non-null; the visibility of the annotation
visibility)

Construct an instance.

Method Summary

Modifier and TypeMethod and Description
public void
add(NameValuePair
non-null; the (name, value) pair to add to this instance
pair)

Add an element to the set of (name, value) pairs for this instance.

public int
compareTo(Annotation
the object to be compared.
other)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public boolean
equals(Object
the reference object with which to compare.
other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public Collection<NameValuePair>

Returns:

non-null; the set of name-value pairs
getNameValuePairs()

Gets the set of name-value pairs contained in this instance.

public CstType

Returns:

non-null; the type
getType()

Gets the type of this instance.

public AnnotationVisibility

Returns:

non-null; the visibility
getVisibility()

Gets the visibility of this instance.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public void
put(NameValuePair
non-null; the (name, value) pair to place into this instance
pair)

Put an element into the set of (name, value) pairs for this instance.

public String
toHuman()

Implements org.droidparts.dexmaker.dx.util.ToHuman.toHuman.

Return the "human" string form of this instance.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from org.droidparts.dexmaker.dx.util.MutabilityControl:
isImmutableisMutablesetImmutablethrowIfImmutablethrowIfMutable

Field Detail

elementsback to summary
private final TreeMap<CstString, NameValuePair> elements

non-null; map from names to NameValuePair instances

typeback to summary
private final CstType type

non-null; type of the annotation

visibilityback to summary
private final AnnotationVisibility visibility

non-null; the visibility of the annotation

Constructor Detail

Annotationback to summary
public Annotation(CstType type, AnnotationVisibility visibility)

Construct an instance. It initially contains no elements.

Parameters
type:CstType

non-null; type of the annotation

visibility:AnnotationVisibility

non-null; the visibility of the annotation

Method Detail

addback to summary
public void add(NameValuePair pair)

Add an element to the set of (name, value) pairs for this instance. It is an error to call this method if there is a preexisting element with the same name.

Parameters
pair:NameValuePair

non-null; the (name, value) pair to add to this instance

compareToback to summary
public int compareTo(Annotation other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:Annotation

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

equalsback to summary
public boolean equals(Object other)

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.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getNameValuePairsback to summary
public Collection<NameValuePair> getNameValuePairs()

Gets the set of name-value pairs contained in this instance. The result is always unmodifiable.

Returns:Collection<NameValuePair>

non-null; the set of name-value pairs

getTypeback to summary
public CstType getType()

Gets the type of this instance.

Returns:CstType

non-null; the type

getVisibilityback to summary
public AnnotationVisibility getVisibility()

Gets the visibility of this instance.

Returns:AnnotationVisibility

non-null; the visibility

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.
Returns:int

a hash code value for this object

putback to summary
public void put(NameValuePair pair)

Put an element into the set of (name, value) pairs for this instance. If there is a preexisting element with the same name, it will be replaced by this method.

Parameters
pair:NameValuePair

non-null; the (name, value) pair to place into this instance

toHumanback to summary
public String toHuman()

Implements org.droidparts.dexmaker.dx.util.ToHuman.toHuman.

Doc from org.droidparts.dexmaker.dx.util.ToHuman.toHuman.

Return the "human" string form of this instance. This is generally less "debuggy" than toString().

Returns:String

non-null; the human string form

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override