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

public final Class EncodedMethod

extends EncodedMember
implements Comparable<EncodedMethod>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Imports
org.droidparts.dexmaker.dx.dex.code.DalvCode, org.droidparts.dexmaker.dx.rop.code.AccessFlags, org.droidparts.dexmaker.dx.rop.cst.CstMethodRef, .CstString, org.droidparts.dexmaker.dx.rop.type.TypeList, org.droidparts.dexmaker.dx.util.AnnotatedOutput, .Hex, .Leb128Utils, java.io.PrintWriter
Class that representats a method of a class.

Field Summary

Modifier and TypeField and Description
private final CodeItem
code

null-ok; code for the method, if the method is neither abstract nor native

private final CstMethodRef
method

non-null; constant for the method

Constructor Summary

AccessConstructor and Description
public
EncodedMethod(CstMethodRef
non-null; constant for the method
method, int
access flags
accessFlags, DalvCode
null-ok; code for the method, if it is neither abstract nor native
code, TypeList
non-null; list of possibly-thrown exceptions, just used in generating debugging output (listings)
throwsList)

Constructs an instance.

Method Summary

Modifier and TypeMethod and Description
public void
addContents(DexFile
non-null; the file to populate
file)

Implements abstract org.droidparts.dexmaker.dx.dex.file.EncodedMember.addContents.

Populates a DexFile with items from within this instance.
public int
compareTo(EncodedMethod
the object to be compared.
other)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public void
debugPrint(PrintWriter
non-null; where to dump
out, boolean
whether to be verbose with the output
verbose)

Implements abstract org.droidparts.dexmaker.dx.dex.file.EncodedMember.debugPrint.

Does a human-friendly dump of this instance.
public int
encode(DexFile
non-null; file this instance is part of
file, AnnotatedOutput
non-null; where to write to
out, int
>= 0; the previous member index value encoded, or 0 if this is the first element to encode
lastIndex, int
>= 0; sequence number of this instance for annotation purposes
dumpSeq)

Implements abstract org.droidparts.dexmaker.dx.dex.file.EncodedMember.encode.

Encodes this instance to the given output.
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 final CstString
getName()

Implements abstract org.droidparts.dexmaker.dx.dex.file.EncodedMember.getName.

Gets the name.
public final CstMethodRef

Returns:

non-null; the constant
getRef()

Gets the constant for the method.

public final 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.dex.file.EncodedMember:
getAccessFlags

Field Detail

codeback to summary
private final CodeItem code

null-ok; code for the method, if the method is neither abstract nor native

methodback to summary
private final CstMethodRef method

non-null; constant for the method

Constructor Detail

EncodedMethodback to summary
public EncodedMethod(CstMethodRef method, int accessFlags, DalvCode code, TypeList throwsList)

Constructs an instance.

Parameters
method:CstMethodRef

non-null; constant for the method

accessFlags:int

access flags

code:DalvCode

null-ok; code for the method, if it is neither abstract nor native

throwsList:TypeList

non-null; list of possibly-thrown exceptions, just used in generating debugging output (listings)

Method Detail

addContentsback to summary
public void addContents(DexFile file)

Implements abstract org.droidparts.dexmaker.dx.dex.file.EncodedMember.addContents.

Doc from org.droidparts.dexmaker.dx.dex.file.EncodedMember.addContents.

Populates a DexFile with items from within this instance.

Parameters
file:DexFile

non-null; the file to populate

Annotations
@Override
compareToback to summary
public int compareTo(EncodedMethod 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.

Note

This compares the method constants only, ignoring any associated code, because it should never be the case that two different items with the same method constant ever appear in the same list (or same file, even).

Parameters
other:EncodedMethod

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.

debugPrintback to summary
public void debugPrint(PrintWriter out, boolean verbose)

Implements abstract org.droidparts.dexmaker.dx.dex.file.EncodedMember.debugPrint.

Doc from org.droidparts.dexmaker.dx.dex.file.EncodedMember.debugPrint.

Does a human-friendly dump of this instance.

Parameters
out:PrintWriter

non-null; where to dump

verbose:boolean

whether to be verbose with the output

Annotations
@Override
encodeback to summary
public int encode(DexFile file, AnnotatedOutput out, int lastIndex, int dumpSeq)

Implements abstract org.droidparts.dexmaker.dx.dex.file.EncodedMember.encode.

Doc from org.droidparts.dexmaker.dx.dex.file.EncodedMember.encode.

Encodes this instance to the given output.

Parameters
file:DexFile

non-null; file this instance is part of

out:AnnotatedOutput

non-null; where to write to

lastIndex:int

>= 0; the previous member index value encoded, or 0 if this is the first element to encode

dumpSeq:int

>= 0; sequence number of this instance for annotation purposes

Returns:int

>= 0; the member index value that was encoded

Annotations
@Override
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.

getNameback to summary
public final CstString getName()

Implements abstract org.droidparts.dexmaker.dx.dex.file.EncodedMember.getName.

Doc from org.droidparts.dexmaker.dx.dex.file.EncodedMember.getName.

Gets the name.

Returns:CstString

non-null; the name

Annotations
@Override
getRefback to summary
public final CstMethodRef getRef()

Gets the constant for the method.

Returns:CstMethodRef

non-null; the constant

toHumanback to summary
public final 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