com.google.gwt.dev.js.ast

Class JsFunction

java.lang.Object

com.google.gwt.dev.js.ast.JsNode

com.google.gwt.dev.js.ast.JsExpression

com.google.gwt.dev.js.ast.JsLiteral

com.google.gwt.dev.js.ast.JsFunction

All Implemented Interfaces:

HasSourceInfo, CanBooleanEval, HasName, JsVisitable, Serializable

public final class JsFunction
extends JsLiteral
implements HasName

Represents a JavaScript function expression.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected JsBlock	body
protected List<JsParameter>	params
protected JsScope	scope

Constructor Summary

Constructors

Constructor and Description
JsFunction(SourceInfo sourceInfo, JsScope parent) Creates an anonymous function.
JsFunction(SourceInfo sourceInfo, JsScope parent, JsName name) Creates a function that is not derived from Java source.
JsFunction(SourceInfo sourceInfo, JsScope parent, JsName name, boolean fromJava) Creates a named function, possibly derived from Java source.

Method Summary

Methods

Modifier and Type	Method and Description
static JsFunction	createSentinel() Creates a dummy JsFunction object to be used as a sentinel.
JsBlock	getBody()
boolean	getExecuteOnce() If true, this indicates that only the first invocation of the function will have any effects.
JsFunction	getImpliedExecute()
NodeKind	getKind()
JsName	getName()
List<JsParameter>	getParameters()
JsScope	getScope()
boolean	hasSideEffects() Determines whether the expression can cause side effects.
boolean	isArtificiallyRescued()
boolean	isBooleanFalse()
boolean	isBooleanTrue()
boolean	isDefinitelyNotNull() True if the target expression is definitely not null.
boolean	isDefinitelyNull() True if the target expression is definitely null.
boolean	isFromJava()
void	setArtificiallyRescued(boolean rescued)
void	setBody(JsBlock body)
void	setExecuteOnce(boolean executeOnce)
void	setFromJava(boolean fromJava)
void	setImpliedExecute(JsFunction impliedExecute)
void	setName(JsName name)
void	setTrace()
void	traverse(JsVisitor v, JsContext ctx) Causes this object to have the visitor visit itself and its children.

Methods inherited from class com.google.gwt.dev.js.ast.JsLiteral

isInternable

Methods inherited from class com.google.gwt.dev.js.ast.JsExpression

isLeaf, makeStmt

Methods inherited from class com.google.gwt.dev.js.ast.JsNode

getSourceInfo, setSourceInfo, toSource, toSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

body

protected JsBlock body

params

protected final List<JsParameter> params

scope

protected final JsScope scope

Constructor Detail

JsFunction

public JsFunction(SourceInfo sourceInfo,
          JsScope parent)

Creates an anonymous function.

JsFunction

public JsFunction(SourceInfo sourceInfo,
          JsScope parent,
          JsName name)

Creates a function that is not derived from Java source.

JsFunction

public JsFunction(SourceInfo sourceInfo,
          JsScope parent,
          JsName name,
          boolean fromJava)

Creates a named function, possibly derived from Java source.

Method Detail

createSentinel

public static JsFunction createSentinel()

Creates a dummy JsFunction object to be used as a sentinel.

Returns:

a dummy JsFunction object.

getBody

public JsBlock getBody()

getExecuteOnce

public boolean getExecuteOnce()

If true, this indicates that only the first invocation of the function will have any effects. Subsequent invocations may be considered to be no-op calls whose return value is ignored.

getImpliedExecute

public JsFunction getImpliedExecute()

getKind

public NodeKind getKind()

Specified by:

getKind in class JsNode

getName

public JsName getName()

Specified by:

getName in interface HasName

getParameters

public List<JsParameter> getParameters()

getScope

public JsScope getScope()

hasSideEffects

public boolean hasSideEffects()

Description copied from class: JsExpression

Determines whether the expression can cause side effects.

Specified by:

hasSideEffects in class JsExpression

isArtificiallyRescued

public boolean isArtificiallyRescued()

isBooleanFalse

public boolean isBooleanFalse()

Specified by:

isBooleanFalse in interface CanBooleanEval

isBooleanTrue

public boolean isBooleanTrue()

Specified by:

isBooleanTrue in interface CanBooleanEval

isDefinitelyNotNull

public boolean isDefinitelyNotNull()

Description copied from class: JsExpression

True if the target expression is definitely not null.

Specified by:

isDefinitelyNotNull in class JsExpression

isDefinitelyNull

public boolean isDefinitelyNull()

Description copied from class: JsExpression

True if the target expression is definitely null.

Specified by:

isDefinitelyNull in class JsExpression

isFromJava

public boolean isFromJava()

setArtificiallyRescued

public void setArtificiallyRescued(boolean rescued)

setBody

public void setBody(JsBlock body)

setExecuteOnce

public void setExecuteOnce(boolean executeOnce)

setFromJava

public void setFromJava(boolean fromJava)

setImpliedExecute

public void setImpliedExecute(JsFunction impliedExecute)

setName

public void setName(JsName name)

setTrace

public void setTrace()

traverse

public void traverse(JsVisitor v,
            JsContext ctx)

Description copied from interface: JsVisitable

Causes this object to have the visitor visit itself and its children.

Specified by:

traverse in interface JsVisitable

Parameters:

v - the visitor that should traverse this node

ctx - the context of an existing traversal