org.sonar.javascript.se

Class ProgramState

java.lang.Object

org.sonar.javascript.se.ProgramState

public class ProgramState
extends Object

This class represents the knowledge about the variables values. The same program state may be valid for several program points and at one program point there might be valid several program states (depending on execution path). This class is immutable.

Method Summary

Modifier and Type	Method and Description
ProgramState	assignment(Symbol variable)
ProgramState	clearStack()
ProgramState	constrain(SymbolicValue value, Constraint constraint)
Map<Symbol,Constraint>	constraintsBySymbol()
static ProgramState	emptyState()
boolean	equals(Object o)
ProgramState	execute(ExpressionTree expression)
Constraint	getConstraint(Symbol symbol)
Constraint	getConstraint(SymbolicValue value)
Nullability	getNullability(SymbolicValue value)
SymbolicValue	getSymbolicValue(Symbol symbol)
int	hashCode()
ProgramState	newSymbolicValue(Symbol symbol, Constraint constraint)
SymbolicValue	peekStack()
ProgramState	pushToStack(SymbolicValue value)
ProgramState	removeSymbols(Set<Symbol> symbolsToKeep)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

emptyState

public static ProgramState emptyState()

newSymbolicValue

public ProgramState newSymbolicValue(Symbol symbol,
                                     @Nullable
                                     Constraint constraint)

constrain

public ProgramState constrain(@Nullable
                              SymbolicValue value,
                              @Nullable
                              Constraint constraint)

getSymbolicValue

@CheckForNull
public SymbolicValue getSymbolicValue(@Nullable
                                                    Symbol symbol)

getConstraint

public Constraint getConstraint(@Nullable
                                SymbolicValue value)

getConstraint

public Constraint getConstraint(@Nullable
                                Symbol symbol)

getNullability

public Nullability getNullability(@Nullable
                                  SymbolicValue value)

constraintsBySymbol

public Map<Symbol,Constraint> constraintsBySymbol()

pushToStack

public ProgramState pushToStack(@Nullable
                                SymbolicValue value)

clearStack

public ProgramState clearStack()

execute

public ProgramState execute(ExpressionTree expression)

assignment

public ProgramState assignment(Symbol variable)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

peekStack

public SymbolicValue peekStack()

removeSymbols

public ProgramState removeSymbols(Set<Symbol> symbolsToKeep)

toString

public String toString()

Overrides:

toString in class Object