Top Description Fields Constructors Methods
org.droidparts.dexmaker.dx.dex.file

public final Class ParameterAnnotationStruct

extends Object
implements ToHuman, Comparable<ParameterAnnotationStruct>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable, org.droidparts.dexmaker.dx.util.ToHuman
Imports
org.droidparts.dexmaker.dx.rop.annotation.Annotations, .AnnotationsList, org.droidparts.dexmaker.dx.rop.cst.CstMethodRef, org.droidparts.dexmaker.dx.util.AnnotatedOutput, .Hex, .ToHuman, java.util.ArrayList

Association of a method and its parameter annotations.

Field Summary

Modifier and TypeField and Description
private final UniformListItem<AnnotationSetRefItem>
annotationsItem

non-null; the associated annotations list, as an item

private final AnnotationsList
annotationsList

non-null; the associated annotations list

private final CstMethodRef
method

non-null; the method in question

Constructor Summary

AccessConstructor and Description
public
ParameterAnnotationStruct(CstMethodRef
non-null; the method in question
method
,
AnnotationsList
non-null; the associated annotations list
annotationsList
)

Constructs an instance.

Method Summary

Modifier and TypeMethod and Description
public void
public int
compareTo(ParameterAnnotationStruct
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 AnnotationsList

Returns:

non-null; the annotations list
getAnnotationsList
()

Gets the associated annotations list.

public CstMethodRef

Returns:

non-null; the method
getMethod
()

Gets the method this item is for.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public String
toHuman()

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

Return the "human" string form of this instance.
public void
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

annotationsItemback to summary
private final UniformListItem<AnnotationSetRefItem> annotationsItem

non-null; the associated annotations list, as an item

annotationsListback to summary
private final AnnotationsList annotationsList

non-null; the associated annotations list

methodback to summary
private final CstMethodRef method

non-null; the method in question

Constructor Detail

ParameterAnnotationStructback to summary
public ParameterAnnotationStruct(CstMethodRef method, AnnotationsList annotationsList)

Constructs an instance.

Parameters
method:CstMethodRef

non-null; the method in question

annotationsList:AnnotationsList

non-null; the associated annotations list

Method Detail

addContentsback to summary
public void addContents(DexFile file)
compareToback to summary
public int compareTo(ParameterAnnotationStruct 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:ParameterAnnotationStruct

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.

getAnnotationsListback to summary
public AnnotationsList getAnnotationsList()

Gets the associated annotations list.

Returns:AnnotationsList

non-null; the annotations list

getMethodback to summary
public CstMethodRef getMethod()

Gets the method this item is for.

Returns:CstMethodRef

non-null; the method

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

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

writeToback to summary
public void writeTo(DexFile file, AnnotatedOutput out)