Package edu.umd.cs.findbugs.ba
Class Location
java.lang.Object
edu.umd.cs.findbugs.ba.Location
- All Implemented Interfaces:
Comparable<Location>
A class representing a location in the CFG for a method. Essentially, it represents a static instruction, with the important caveat that CFGs have inlined JSR subroutines, meaning that a single InstructionHandle in a CFG may represent several static locations. To this end, a Location is comprised of both an InstructionHandle and the BasicBlock that contains it.
Location objects may be compared with each other using the equals() method, and may be used as keys in tree and hash maps and sets. Note that it is only valid to compare Locations produced from the same CFG.
- Author:
- David Hovemeyer
- See Also:
-
Constructor Summary
ConstructorDescriptionLocation
(org.apache.bcel.generic.InstructionHandle handle, BasicBlock basicBlock) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionint
boolean
Get the basic block.static Location
getFirstLocation
(BasicBlock basicBlock) org.apache.bcel.generic.InstructionHandle
Get the instruction handle.static Location
getLastLocation
(BasicBlock basicBlock) int
hashCode()
boolean
Return whether or not the Location is positioned at the first instruction in the basic block.boolean
Return whether or not the Location is positioned at the last instruction in the basic block.toString()
-
Constructor Details
-
Location
public Location(@Nonnull org.apache.bcel.generic.InstructionHandle handle, @Nonnull BasicBlock basicBlock) Constructor.- Parameters:
handle
- the instructionbasicBlock
- the basic block containing the instruction
-
-
Method Details
-
getFirstLocation
-
getLastLocation
-
getHandle
@Nonnull public org.apache.bcel.generic.InstructionHandle getHandle()Get the instruction handle. -
getBasicBlock
Get the basic block. -
isFirstInstructionInBasicBlock
public boolean isFirstInstructionInBasicBlock()Return whether or not the Location is positioned at the first instruction in the basic block. -
isLastInstructionInBasicBlock
public boolean isLastInstructionInBasicBlock()Return whether or not the Location is positioned at the last instruction in the basic block. -
compareTo
- Specified by:
compareTo
in interfaceComparable<Location>
-
hashCode
public int hashCode() -
equals
-
toString
-
toCompactString
- Returns:
- a compact string of the form "bb:xx", where "bb" is the basic block number and "xx" is the bytecode offset
-