com.google.javascript.jscomp

Class CodingConvention.AssertionFunctionSpec

java.lang.Object

com.google.javascript.jscomp.CodingConvention.AssertionFunctionSpec

Direct Known Subclasses:

ClosureCodingConvention.AssertFunctionByTypeName, ClosureCodingConvention.AssertInstanceofSpec

Enclosing interface:

CodingConvention

public static class CodingConvention.AssertionFunctionSpec
extends Object

A function that will throw an exception when either: -One or more of its parameters evaluate to false. -One or more of its parameters are not of a certain type.

Field Summary

Fields

Modifier and Type	Field and Description
protected JSType	assertedNewType
protected JSTypeNative	assertedType
protected String	functionName

Constructor Summary

Constructors

Constructor and Description
AssertionFunctionSpec(String functionName) Deprecated.
AssertionFunctionSpec(String functionName, JSType assertedNewType)
AssertionFunctionSpec(String functionName, JSType assertedNewType, JSTypeNative assertedType)

Method Summary

Modifier and Type	Method and Description
JSType	getAssertedNewType(Node call, DeclaredTypeRegistry scope) Returns the new type system type for a type assertion.
JSType	getAssertedOldType(Node call, JSTypeRegistry registry) Returns the old type system type for a type assertion, or null if the function asserts that the node must not be null or undefined.
Node	getAssertedParam(Node firstParam) Returns the parameter of the assertion function that is being checked.
String	getFunctionName() Returns the name of the function.

Methods inherited from class java.lang.Object

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

Field Detail

functionName

protected final String functionName

assertedType

protected final JSTypeNative assertedType

assertedNewType

protected final JSType assertedNewType

Constructor Detail

AssertionFunctionSpec

@Deprecated
public AssertionFunctionSpec(String functionName)

Deprecated.

AssertionFunctionSpec

public AssertionFunctionSpec(String functionName,
                             JSType assertedNewType)

AssertionFunctionSpec

public AssertionFunctionSpec(String functionName,
                             JSType assertedNewType,
                             JSTypeNative assertedType)

Method Detail

getFunctionName

public String getFunctionName()

Returns the name of the function.

getAssertedParam

public Node getAssertedParam(Node firstParam)

Returns the parameter of the assertion function that is being checked.

Parameters:

firstParam - The first parameter of the function call.

getAssertedOldType

public JSType getAssertedOldType(Node call,
                                 JSTypeRegistry registry)

Returns the old type system type for a type assertion, or null if the function asserts that the node must not be null or undefined.

Parameters:

call - The asserting call

getAssertedNewType

public JSType getAssertedNewType(Node call,
                                 DeclaredTypeRegistry scope)

Returns the new type system type for a type assertion.

Parameters:

call - The asserting call