com.google.javascript.jscomp

Class CodingConvention.AssertionFunctionSpec

java.lang.Object

com.google.javascript.jscomp.CodingConvention.AssertionFunctionSpec

Enclosing interface:

CodingConvention

public static final class CodingConvention.AssertionFunctionSpec
extends java.lang.Object

A description of a JavaScript function that will throw an exception when either:

• One of its parameters does not match the return type of the function
• One of its parameters is falsy. This has some special handling for expressions that the match-return-type handling does not have.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodingConvention.AssertionFunctionSpec.AssertionKind

Method Summary

Modifier and Type	Method and Description
Node	getAssertedArg(Node firstArg) Returns which argument is actually being asserted, or null if fewer args than expected
java.lang.String	getFunctionName() Returns the name of the function.
static CodingConvention.AssertionFunctionSpec	makeReturnTypeAssertion(java.lang.String functionName) Returns an assertion function asserting the first param matches the return type
static CodingConvention.AssertionFunctionSpec	makeTruthyAssertion(java.lang.String functionName) Returns a truthy assertion function on the first param
static CodingConvention.AssertionFunctionSpec	makeTruthyAssertion(java.lang.String functionName, int paramIndex) Returns an assertion function asserting the nth arg is truthy (0-indexed)

Methods inherited from class java.lang.Object

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

Method Detail

makeTruthyAssertion

public static CodingConvention.AssertionFunctionSpec makeTruthyAssertion(java.lang.String functionName)

Returns a truthy assertion function on the first param

makeReturnTypeAssertion

public static CodingConvention.AssertionFunctionSpec makeReturnTypeAssertion(java.lang.String functionName)

Returns an assertion function asserting the first param matches the return type

makeTruthyAssertion

public static CodingConvention.AssertionFunctionSpec makeTruthyAssertion(java.lang.String functionName,
                                                                         int paramIndex)

Returns an assertion function asserting the nth arg is truthy (0-indexed)

getFunctionName

public java.lang.String getFunctionName()

Returns the name of the function.

getAssertedArg

@Nullable
public Node getAssertedArg(Node firstArg)

Returns which argument is actually being asserted, or null if fewer args than expected