org.sonar.javascript.se

Class ExpressionStack

java.lang.Object

org.sonar.javascript.se.ExpressionStack

public class ExpressionStack
extends Object

This class stores the stack of symbolic values corresponding to the order of expression evaluation. Each ProgramState has corresponding instance of ExpressionStack. Note that this class is immutable.

Method Summary

Modifier and Type	Method and Description
ExpressionStack	apply(Consumer<Deque<SymbolicValue>> action) This method allows to perform one or more operations on a copy of the internal stack.
static ExpressionStack	emptyStack()
boolean	equals(Object obj)
ExpressionStack	execute(ExpressionTree expression, ProgramStateConstraints constraints) This method executes expression: it pushes to the stack a new symbolic value based (if required) on popped symbolic values.
int	hashCode()
boolean	isEmpty()
SymbolicValue	peek()
SymbolicValue	peek(int n)
ExpressionStack	push(SymbolicValue newValue)
ExpressionStack	removeLastValue()
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

emptyStack

public static ExpressionStack emptyStack()

push

public ExpressionStack push(SymbolicValue newValue)

execute

public ExpressionStack execute(ExpressionTree expression,
                               ProgramStateConstraints constraints)

This method executes expression: it pushes to the stack a new symbolic value based (if required) on popped symbolic values. Note that as ExpressionStack is an immutable class, this method will return new resulting instance of ExpressionStack while the calling this method instance will not be changed.

Parameters:

expression - to be executed

constraints -

Returns:

resulting ExpressionStack

peek

public SymbolicValue peek()

size

public int size()

isEmpty

public boolean isEmpty()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

peek

public SymbolicValue peek(int n)

removeLastValue

public ExpressionStack removeLastValue()

apply

public ExpressionStack apply(Consumer<Deque<SymbolicValue>> action)

This method allows to perform one or more operations on a copy of the internal stack. It thus guarantees ExpressionStack immutability.

Parameters:

action - the operation to perform on the internal stack

Returns:

a new instance of ExpressionStack containing the copy of the internal stack modified by the operation

toString

public String toString()

Overrides:

toString in class Object