Class CodingConvention.AssertionFunctionSpec

  • Direct Known Subclasses:
    ClosureCodingConvention.AssertInstanceofSpec
    Enclosing interface:
    CodingConvention

    public static class CodingConvention.AssertionFunctionSpec
    extends java.lang.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 Detail

      • functionName

        protected final java.lang.String functionName
    • Constructor Detail

      • AssertionFunctionSpec

        public AssertionFunctionSpec​(java.lang.String functionName)
      • AssertionFunctionSpec

        public AssertionFunctionSpec​(java.lang.String functionName,
                                     JSTypeNative assertedType)
    • Method Detail

      • getFunctionName

        public java.lang.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.
      • getAssertedType

        public JSType getAssertedType​(Node call,
                                      JSTypeRegistry registry)
        Returns the 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