Enum JSType.Nullability

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<JSType.Nullability>
    Enclosing class:
    JSType

    public static enum JSType.Nullability
    extends java.lang.Enum<JSType.Nullability>
    Specifies how to express nullability of reference types in annotation strings and error messages. Note that this only applies to the outer-most type. Nullability of generic type arguments is always explicit.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EXPLICIT
      Include an explicit '!' for non-nullable reference types.
      IMPLICIT
      Omit the explicit '!' from the outermost non-nullable reference type.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static JSType.Nullability valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static JSType.Nullability[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • EXPLICIT

        public static final JSType.Nullability EXPLICIT
        Include an explicit '!' for non-nullable reference types. This is suitable for use in most type contexts (particularly 'type', 'param', and 'return' annotations).
      • IMPLICIT

        public static final JSType.Nullability IMPLICIT
        Omit the explicit '!' from the outermost non-nullable reference type. This is suitable for use in cases where a single reference type is expected (e.g. 'extends' and 'implements').
    • Method Detail

      • values

        public static JSType.Nullability[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (JSType.Nullability c : JSType.Nullability.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static JSType.Nullability valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null