Package edu.umd.cs.findbugs.ba.npe

Class ReturnPathType

java.lang.Object

edu.umd.cs.findbugs.ba.npe.ReturnPathType

public class ReturnPathType
extends java.lang.Object

A dataflow value that indicates what kind of return path is possible at the current program location. Either:

• It is possible to return normally
• It is not possible to return normally (i.e., an exception is guaranteed to be thrown)

Field Summary

Fields

Modifier and Type	Field	Description
private static int	CAN_RETURN_NORMALLY
private static int	CANNOT_RETURN_NORMALLY
private static int	TOP
private int	type

Constructor Summary

Constructors

Constructor	Description
ReturnPathType()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	canReturnNormally()
void	copyFrom(ReturnPathType other)	Make this dataflow fact an exact copy of the other one.
boolean	isTop()
boolean	isValid()
void	mergeWith(ReturnPathType fact)	Merge this fact with given fact.
(package private) boolean	sameAs(ReturnPathType other)	Determine whether this dataflow fact is identical to another one.
void	setCanReturnNormally(boolean canReturnNormally)	Set whether or not it is possible to return normally.
void	setTop()	Set the dataflow fact to top.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CAN_RETURN_NORMALLY

private static final int CAN_RETURN_NORMALLY

See Also:

Constant Field Values

CANNOT_RETURN_NORMALLY

private static final int CANNOT_RETURN_NORMALLY

See Also:

Constant Field Values

TOP

private static final int TOP

See Also:

Constant Field Values

type

private int type

Constructor Detail

ReturnPathType

public ReturnPathType()

Constructor. Creates a top dataflow fact.

Method Detail

canReturnNormally

public boolean canReturnNormally()
                          throws DataflowAnalysisException

Returns:

true if the method can return normally at this location, false otherwise

Throws:

DataflowAnalysisException

copyFrom

public void copyFrom(ReturnPathType other)

Make this dataflow fact an exact copy of the other one.

Parameters:

other - another dataflow fact

setTop

public void setTop()

Set the dataflow fact to top.

isTop

public boolean isTop()

Returns:

true if the dataflow fact is top, false otherwise

setCanReturnNormally

public void setCanReturnNormally(boolean canReturnNormally)

Set whether or not it is possible to return normally.

Parameters:

canReturnNormally - true if the method can return normally at this location, false otherwise

mergeWith

public void mergeWith(ReturnPathType fact)

Merge this fact with given fact.

Parameters:

fact - another dataflow fact

sameAs

boolean sameAs(ReturnPathType other)

Determine whether this dataflow fact is identical to another one.

Parameters:

other - another dataflow fact

Returns:

true if the two dataflow facts are identical, false if they are different

isValid

public boolean isValid()

Returns:

true if this is a valid dataflow fact (not top or bottom), false if not a valid dataflow fact

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object