Class SwitchHandler

java.lang.Object

edu.umd.cs.findbugs.SwitchHandler

public class SwitchHandler
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SwitchHandler.SwitchDetails

Field Summary

Fields

Modifier and Type	Field	Description
private final List<SwitchHandler.SwitchDetails>	switchOffsetStack
private final Set<Integer>	typeSwitchPC	The set of program counters for the 'switch' instruction of each of the type switches

Constructor Summary

Constructors

Constructor	Description
SwitchHandler()

Method Summary

Modifier and Type	Method	Description
void	enterSwitch(int opCode, int pc, int[] switchOffsets, int defaultSwitchOffset, boolean exhaustive)
void	enterSwitch(DismantleBytecode dbc, XClass enumType)
private SwitchHandler.SwitchDetails	findSwitchDetailsByPc(int... possiblePC)	Finds a switch from the first PC of a case
SourceLineAnnotation	getCurrentSwitchStatement(BytecodeScanningDetector detector)
int	getDefaultOffset()
SwitchHandler.SwitchDetails	getNextSwitchDetails(DismantleBytecode dbc)
int	getNextSwitchOffset(DismantleBytecode dbc)
boolean	isOnSwitchOffset(DismantleBytecode dbc)
boolean	isTypeSwitchCaseCheckCast(int opCode, int pc)	In type switches a CHECKCAST is inserted by the compiler for each case.
boolean	isTypeSwitchCaseLoad(Location location)	In type switches an ASTORE is inserted by the compiler for each case.
(package private) int	numEnumValues(XClass c)
void	sawInvokeDynamic(int pc, String methodName)	For type switches introduced in Java 21 we are using the invocation of a bootstrap 'typeswitch()' method to detect that the switch operates on the class of the object.
int	stackSize()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

switchOffsetStack

private final List<SwitchHandler.SwitchDetails> switchOffsetStack

typeSwitchPC

private final Set<Integer> typeSwitchPC

The set of program counters for the 'switch' instruction of each of the type switches

Constructor Details

SwitchHandler

public SwitchHandler()

Method Details

stackSize

public int stackSize()

numEnumValues

int numEnumValues(@CheckForNull
 XClass c)

enterSwitch

public void enterSwitch(DismantleBytecode dbc,
 @CheckForNull
 XClass enumType)

enterSwitch

public void enterSwitch(int opCode,
 int pc,
 int[] switchOffsets,
 int defaultSwitchOffset,
 boolean exhaustive)

Parameters:

opCode - The op code of the switch, should be TABLESWITCH or LOOKUPSWITCH

pc - The PC of the switch instruction

switchOffsets - The PC offsets of the switch cases

defaultSwitchOffset - The PC of the default case

exhaustive - true if the switch is exhaustive

isOnSwitchOffset

public boolean isOnSwitchOffset(DismantleBytecode dbc)

getNextSwitchOffset

public int getNextSwitchOffset(DismantleBytecode dbc)

getNextSwitchDetails

@CheckForNull
public SwitchHandler.SwitchDetails getNextSwitchDetails(DismantleBytecode dbc)

getDefaultOffset

public int getDefaultOffset()

getCurrentSwitchStatement

public SourceLineAnnotation getCurrentSwitchStatement(BytecodeScanningDetector detector)

sawInvokeDynamic

public void sawInvokeDynamic(int pc,
 String methodName)

For type switches introduced in Java 21 we are using the invocation of a bootstrap 'typeswitch()' method to detect that the switch operates on the class of the object.

Parameters:

pc -

methodName -

isTypeSwitchCaseCheckCast

public boolean isTypeSwitchCaseCheckCast(int opCode,
 int pc)

In type switches a CHECKCAST is inserted by the compiler for each case. This method checks if the instruction is one of these casts and then checks if the corresponding switch is a type switch.

Parameters:

opCode - The operation code

pc - The program counter

Returns:

trueIf this instruction is a cast for a type switch

isTypeSwitchCaseLoad

public boolean isTypeSwitchCaseLoad(Location location)

In type switches an ASTORE is inserted by the compiler for each case. This method checks if the instruction is one of these loads and then checks if the corresponding switch is a type switch. We're looking for: an ASTORE preceded by a CHECKCAST preceded by an instruction at the offset of a switch case

Parameters:

location - The Location

Returns:

trueIf this instruction is a load for a type switch

findSwitchDetailsByPc

private SwitchHandler.SwitchDetails findSwitchDetailsByPc(int... possiblePC)

Finds a switch from the first PC of a case

Parameters:

possiblePC - The possible first PC of a switch case

Returns:

The SwitchDetails of the switch corresponding to the case or null if there was no case at this PC