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

public final Class SourcePosition

extends Object
Class Inheritance
Imports
org.droidparts.dexmaker.dx.rop.cst.CstString, org.droidparts.dexmaker.dx.util.Hex

Information about a source position for code, which includes both a line number and original bytecode address.

Field Summary

Modifier and TypeField and Description
private final int
address

>= -1; the bytecode address, or -1 if that information is unknown

private final int
line

>= -1; the line number, or -1 if that information is unknown

public static final SourcePosition
NO_INFO

non-null; convenient "no information known" instance

private final CstString
sourceFile

null-ok; name of the file of origin or null if unknown

Constructor Summary

AccessConstructor and Description
public
SourcePosition(CstString
null-ok; name of the file of origin or null if unknown
sourceFile
,
int
>= -1; original bytecode address or -1 if unknown
address
,
int
>= -1; original line number or -1 if unknown
line
)

Constructs an instance.

Method Summary

Modifier and TypeMethod and Description
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 int

Returns:

>= -1; the address or -1 if unknown
getAddress
()

Gets the original bytecode address.

public int

Returns:

>= -1; the original line number or -1 if unknown
getLine
()

Gets the original line number.

public CstString

Returns:

null-ok; the source file or null if unknown
getSourceFile
()

Gets the source file, if known.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public boolean

Returns:

true iff the lines match
sameLine
(SourcePosition
non-null; the instance to compare to
other
)

Returns whether the lines match between this instance and the one given.

public boolean

Returns:

true iff the lines and files match
sameLineAndFile
(SourcePosition
non-null; the instance to compare to
other
)

Returns whether the lines and files match between this instance and the one given.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

addressback to summary
private final int address

>= -1; the bytecode address, or -1 if that information is unknown

lineback to summary
private final int line

>= -1; the line number, or -1 if that information is unknown

NO_INFOback to summary
public static final SourcePosition NO_INFO

non-null; convenient "no information known" instance

sourceFileback to summary
private final CstString sourceFile

null-ok; name of the file of origin or null if unknown

Constructor Detail

SourcePositionback to summary
public SourcePosition(CstString sourceFile, int address, int line)

Constructs an instance.

Parameters
sourceFile:CstString

null-ok; name of the file of origin or null if unknown

address:int

>= -1; original bytecode address or -1 if unknown

line:int

>= -1; original line number or -1 if unknown

Method Detail

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
getAddressback to summary
public int getAddress()

Gets the original bytecode address.

Returns:int

>= -1; the address or -1 if unknown

getLineback to summary
public int getLine()

Gets the original line number.

Returns:int

>= -1; the original line number or -1 if unknown

getSourceFileback to summary
public CstString getSourceFile()

Gets the source file, if known.

Returns:CstString

null-ok; the source file or null if unknown

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

Annotations
@Override
sameLineback to summary
public boolean sameLine(SourcePosition other)

Returns whether the lines match between this instance and the one given.

Parameters
other:SourcePosition

non-null; the instance to compare to

Returns:boolean

true iff the lines match

sameLineAndFileback to summary
public boolean sameLineAndFile(SourcePosition other)

Returns whether the lines and files match between this instance and the one given.

Parameters
other:SourcePosition

non-null; the instance to compare to

Returns:boolean

true iff the lines and files match

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