Package org.sonar.java.se

Class ProgramState

java.lang.Object

org.sonar.java.se.ProgramState

public class ProgramState
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProgramState.Pop
static class	ProgramState.SymbolicValueSymbol	This class is used to keep on stack symbolic value together with symbol which was used to evaluate this value.

Field Summary

Fields

Modifier and Type	Field	Description
static final ProgramState	EMPTY_STATE

Method Summary

Modifier and Type	Method	Description
ProgramState	addConstraint(SymbolicValue symbolicValue, Constraint constraint)
ProgramState	addConstraints(SymbolicValue symbolicValue, ConstraintsByDomain constraintsForSV)
ProgramState	addConstraintTransitively(SymbolicValue symbolicValue, Constraint constraint)
boolean	canReach(SymbolicValue symbolicValue)
ProgramState	cleanupConstraints(Collection<SymbolicValue> protectedSymbolicValues)
ProgramState	cleanupDeadSymbols(Set<Symbol> liveVariables, Collection<SymbolicValue> protectedSymbolicValues)
int	constraintsSize()
boolean	equals(Object o)
boolean	exitingOnRuntimeException()
SymbolicValue	exitValue()
<T extends Constraint> T	getConstraint(SymbolicValue sv, Class<T> domain)
ConstraintsByDomain	getConstraints(SymbolicValue sv)
SymbolicValue.ExceptionalSymbolicValue	getEntryException()
SymbolicValue	getValue(int index)
SymbolicValue	getValue(Symbol symbol)
List<SymbolicValue>	getValuesWithConstraints(Constraint constraint)
int	hashCode()
static boolean	isField(Symbol symbol)
Set<RelationalSymbolicValue>	knownRelations()
int	numberOfTimeVisited(ProgramPoint programPoint)
SymbolicValue	peekValue()
SymbolicValue	peekValue(int i)
List<SymbolicValue>	peekValues(int n)
List<ProgramState.SymbolicValueSymbol>	peekValuesAndSymbols(int n)
ProgramState.SymbolicValueSymbol	peekValueSymbol()
ProgramState	put(Symbol symbol, SymbolicValue value)	To be used only by the ExplodedGraphWalker only, when manipulating program states.
ProgramState	removeConstraintsOnDomain(SymbolicValue sv, Class<? extends Constraint> domain)
ProgramState	stackValue(SymbolicValue sv)
ProgramState	stackValue(SymbolicValue sv, Symbol symbol)
void	storeExitValue()
void	storeExitValue(SymbolicValue exitSymbolicValue)
String	toString()
ProgramState.Pop	unstackValue(int nbElements)
ProgramState	visitedPoint(ProgramPoint programPoint, int nbOfVisit)
ProgramState	withEntryException(SymbolicValue.ExceptionalSymbolicValue exception)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY_STATE

public static final ProgramState EMPTY_STATE

Method Details

withEntryException

public ProgramState withEntryException(@Nullable
 SymbolicValue.ExceptionalSymbolicValue exception)

getEntryException

@CheckForNull
public SymbolicValue.ExceptionalSymbolicValue getEntryException()

stackValue

public ProgramState stackValue(SymbolicValue sv)

stackValue

public ProgramState stackValue(SymbolicValue sv,
 @Nullable
 Symbol symbol)

unstackValue

public ProgramState.Pop unstackValue(int nbElements)

peekValue

@CheckForNull
public SymbolicValue peekValue()

peekValueSymbol

public ProgramState.SymbolicValueSymbol peekValueSymbol()

peekValue

public SymbolicValue peekValue(int i)

peekValues

public List<SymbolicValue> peekValues(int n)

peekValuesAndSymbols

public List<ProgramState.SymbolicValueSymbol> peekValuesAndSymbols(int n)

numberOfTimeVisited

public int numberOfTimeVisited(ProgramPoint programPoint)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

addConstraintTransitively

public ProgramState addConstraintTransitively(SymbolicValue symbolicValue,
 Constraint constraint)

knownRelations

public Set<RelationalSymbolicValue> knownRelations()

addConstraint

public ProgramState addConstraint(SymbolicValue symbolicValue,
 Constraint constraint)

addConstraints

public ProgramState addConstraints(SymbolicValue symbolicValue,
 ConstraintsByDomain constraintsForSV)

removeConstraintsOnDomain

public ProgramState removeConstraintsOnDomain(SymbolicValue sv,
 Class<? extends Constraint> domain)

put

public ProgramState put(Symbol symbol,
 SymbolicValue value)

To be used only by the ExplodedGraphWalker only, when manipulating program states. Only made 'public' because of some method yield tests.

cleanupDeadSymbols

public ProgramState cleanupDeadSymbols(Set<Symbol> liveVariables,
 Collection<SymbolicValue> protectedSymbolicValues)

cleanupConstraints

public ProgramState cleanupConstraints(Collection<SymbolicValue> protectedSymbolicValues)

isField

public static boolean isField(Symbol symbol)

canReach

public boolean canReach(SymbolicValue symbolicValue)

visitedPoint

public ProgramState visitedPoint(ProgramPoint programPoint,
 int nbOfVisit)

getConstraints

@Nullable
public ConstraintsByDomain getConstraints(SymbolicValue sv)

getConstraint

@CheckForNull
public <T extends Constraint> T getConstraint(SymbolicValue sv,
 Class<T> domain)

constraintsSize

public int constraintsSize()

getValue

@CheckForNull
public SymbolicValue getValue(int index)

getValue

@CheckForNull
public SymbolicValue getValue(Symbol symbol)

getValuesWithConstraints

public List<SymbolicValue> getValuesWithConstraints(Constraint constraint)

storeExitValue

public void storeExitValue()

storeExitValue

public void storeExitValue(@Nullable
 SymbolicValue exitSymbolicValue)

exitValue

@CheckForNull
public SymbolicValue exitValue()

exitingOnRuntimeException

public boolean exitingOnRuntimeException()