com.google.javascript.rhino

Class Node.SideEffectFlags

java.lang.Object

com.google.javascript.rhino.Node.SideEffectFlags

Enclosing class:

Node

public static final class Node.SideEffectFlags
extends java.lang.Object

A helper class for getting and setting invocation side-effect flags.

The following values are of interest:

1. Is global state mutated? (MUTATES_GLOBAL_STATE)
2. Is the receiver (`this`) mutated? (MUTATES_THIS)
3. Are any arguments mutated? (MUTATES_ARGUMENTS)
4. Does the call throw an error? (THROWS)
5. Is the return an escaped (mutable by other code) value? (ESCAPED_RETURN)

Author:

[email protected] (John Lenz)

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_SIDE_EFFECTS
static int	ESCAPED_RETURN
static int	MUTATES_ARGUMENTS
static int	MUTATES_GLOBAL_STATE
static int	MUTATES_THIS
static int	NO_SIDE_EFFECTS
static int	THROWS

Constructor Summary

Constructors

Constructor and Description
SideEffectFlags()
SideEffectFlags(int value)

Method Summary

Modifier and Type	Method and Description
Node.SideEffectFlags	clearAllFlags() No side-effects occur and the returned results are local.
void	clearSideEffectFlags() Preserve the return result flag, but clear the others: no global state change, no throws, no this change, no arguments change
Node.SideEffectFlags	setAllFlags() All side-effect occur and the returned results are non-local.
Node.SideEffectFlags	setMutatesArguments()
Node.SideEffectFlags	setMutatesGlobalState()
Node.SideEffectFlags	setMutatesThis()
Node.SideEffectFlags	setReturnsTainted()
Node.SideEffectFlags	setThrows()
java.lang.String	toString()
int	valueOf()

Methods inherited from class java.lang.Object

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

Field Detail

MUTATES_GLOBAL_STATE

public static final int MUTATES_GLOBAL_STATE

See Also:

Constant Field Values

MUTATES_THIS

public static final int MUTATES_THIS

See Also:

Constant Field Values

MUTATES_ARGUMENTS

public static final int MUTATES_ARGUMENTS

See Also:

Constant Field Values

THROWS

public static final int THROWS

See Also:

Constant Field Values

ESCAPED_RETURN

public static final int ESCAPED_RETURN

See Also:

Constant Field Values

NO_SIDE_EFFECTS

public static final int NO_SIDE_EFFECTS

See Also:

Constant Field Values

ALL_SIDE_EFFECTS

public static final int ALL_SIDE_EFFECTS

See Also:

Constant Field Values

Constructor Detail

SideEffectFlags

public SideEffectFlags()

SideEffectFlags

public SideEffectFlags(int value)

Method Detail

valueOf

public int valueOf()

setAllFlags

public Node.SideEffectFlags setAllFlags()

All side-effect occur and the returned results are non-local.

clearAllFlags

public Node.SideEffectFlags clearAllFlags()

No side-effects occur and the returned results are local.

clearSideEffectFlags

public void clearSideEffectFlags()

Preserve the return result flag, but clear the others: no global state change, no throws, no this change, no arguments change

setMutatesGlobalState

public Node.SideEffectFlags setMutatesGlobalState()

setThrows

public Node.SideEffectFlags setThrows()

setMutatesThis

public Node.SideEffectFlags setMutatesThis()

setMutatesArguments

public Node.SideEffectFlags setMutatesArguments()

setReturnsTainted

public Node.SideEffectFlags setReturnsTainted()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object