Dexmaker 1.5 · org.droidparts.dexmaker.dx.rop.annotation.Annotations

Modifier and Type	Field and Description
private final TreeMap<CstType, Annotation>	annotations `non-null;` map from types to annotations
public static final Annotations	EMPTY `non-null;` immutable empty instance

Access	Constructor and Description
public	Annotations() Constructs an empty instance.

Method Summary

Modifier and Type	Method and Description
public void	add(Annotation `non-null;` the element to add annotation) Adds an element to this instance.
public void	addAll(Annotations `non-null;` the annotations to add toAdd) Adds all of the elements of the given instance to this one.
public static Annotations	Returns: `non-null;` the combination combine(Annotations `non-null;` an instance a1, Annotations `non-null;` the other instance a2) Constructs an immutable instance which is the combination of the two given instances.
public static Annotations	Returns: `non-null;` the combination combine(Annotations `non-null;` the instance to augment annotations, Annotation `non-null;` the additional annotation annotation) Constructs an immutable instance which is the combination of the given instance with the given additional annotation.
public int	compareTo(Annotations 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<Annotation>	Returns: `non-null;` the set of annotations getAnnotations() Gets the set of annotations contained in this instance.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	Returns: `>= 0;` the size size() Gets the number of elements in 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:: isImmutable isMutable setImmutable throwIfImmutable throwIfMutable

annotations	back to summary
private final TreeMap<CstType, Annotation> annotations `non-null;` map from types to annotations

EMPTY	back to summary
public static final Annotations EMPTY `non-null;` immutable empty instance

Annotations	back to summary
public Annotations() Constructs an empty instance.

Method Detail

add back to summary

add	back to summary
public void add(Annotation annotation) Adds an element to this instance. There must not already be an element of the same type. Parameters annotation:Annotation `non-null;` the element to add Exceptions IllegalArgumentException: thrown if there is a duplicate type

public void add(Annotation annotation)

Adds an element to this instance. There must not already be an element of the same type.

Parameters

annotation:Annotation: non-null; the element to add

Exceptions

IllegalArgumentException:: thrown if there is a duplicate type

addAll back to summary

addAll	back to summary
public void addAll(Annotations toAdd) Adds all of the elements of the given instance to this one. The instances must not have any duplicate types. Parameters toAdd:Annotations `non-null;` the annotations to add Exceptions IllegalArgumentException: thrown if there is a duplicate type

public void addAll(Annotations toAdd)

Adds all of the elements of the given instance to this one. The instances must not have any duplicate types.

Parameters

toAdd:Annotations: non-null; the annotations to add

Exceptions

IllegalArgumentException:: thrown if there is a duplicate type

combine back to summary

combine	back to summary
public static Annotations combine(Annotations a1, Annotations a2) Constructs an immutable instance which is the combination of the two given instances. The two instances must contain disjoint sets of types. Parameters a1:Annotations `non-null;` an instance a2:Annotations `non-null;` the other instance Returns:Annotations `non-null;` the combination Exceptions IllegalArgumentException: thrown if there is a duplicate type

public static Annotations combine(Annotations a1, Annotations a2)

Constructs an immutable instance which is the combination of the two given instances. The two instances must contain disjoint sets of types.

Parameters

a1:Annotations: non-null; an instance
a2:Annotations: non-null; the other instance

Returns:Annotations

non-null; the combination

Exceptions

IllegalArgumentException:: thrown if there is a duplicate type

combine back to summary

combine	back to summary
public static Annotations combine(Annotations annotations, Annotation annotation) Constructs an immutable instance which is the combination of the given instance with the given additional annotation. The latter's type must not already appear in the former. Parameters annotations:Annotations `non-null;` the instance to augment annotation:Annotation `non-null;` the additional annotation Returns:Annotations `non-null;` the combination Exceptions IllegalArgumentException: thrown if there is a duplicate type

public static Annotations combine(Annotations annotations, Annotation annotation)

Constructs an immutable instance which is the combination of the given instance with the given additional annotation. The latter's type must not already appear in the former.

Parameters

annotations:Annotations: non-null; the instance to augment
annotation:Annotation: non-null; the additional annotation

Returns:Annotations

non-null; the combination

Exceptions

IllegalArgumentException:: thrown if there is a duplicate type

compareTo back to summary

compareTo	back to summary
public int compareTo(Annotations 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:Annotations 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.

public int compareTo(Annotations 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:Annotations: 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.

equals back to summary

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

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

getAnnotations back to summary

getAnnotations	back to summary
public Collection<Annotation> getAnnotations() Gets the set of annotations contained in this instance. The result is always unmodifiable. Returns:Collection<Annotation> `non-null;` the set of annotations

public Collection<Annotation> getAnnotations()

Gets the set of annotations contained in this instance. The result is always unmodifiable.

Returns:Collection<Annotation>: non-null; the set of annotations

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. Returns:int a hash code value for this object 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.

Returns:int

a hash code value for this object

Annotations

@Override

size back to summary

size	back to summary
public int size() Gets the number of elements in this instance. Returns:int `>= 0;` the size

public int size()

Gets the number of elements in this instance.

Returns:int: >= 0; the size

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. Returns:String a string representation of the object

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.

Returns:String: a string representation of the object

public final Class Annotations

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail