Package com.google.devtools.build.lib.starlarkdocextract

Enum Class StardocOutputProtos.FunctionParamRole

java.lang.Object
java.lang.Enum<StardocOutputProtos.FunctionParamRole>
com.google.devtools.build.lib.starlarkdocextract.StardocOutputProtos.FunctionParamRole
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<StardocOutputProtos.FunctionParamRole>, Constable
Enclosing class:
StardocOutputProtos
public static enum StardocOutputProtos.FunctionParamRole extends Enum<StardocOutputProtos.FunctionParamRole> implements com.google.protobuf.ProtocolMessageEnum
 Representation of the syntactic role of a given function parameter.
Protobuf enum stardoc_output.FunctionParamRole

  • Enum Constant Details

    • PARAM_ROLE_UNSPECIFIED

      public static final StardocOutputProtos.FunctionParamRole PARAM_ROLE_UNSPECIFIED
      PARAM_ROLE_UNSPECIFIED = 0;

    • PARAM_ROLE_ORDINARY

      public static final StardocOutputProtos.FunctionParamRole PARAM_ROLE_ORDINARY
       An ordinary parameter which may be used as a positional or by keyword.
      PARAM_ROLE_ORDINARY = 1;

    • PARAM_ROLE_POSITIONAL_ONLY

      public static final StardocOutputProtos.FunctionParamRole PARAM_ROLE_POSITIONAL_ONLY
       A positional-only parameter; such parameters cannot be defined in pure
 Starlark code, but exist in some natively-defined functions.
      PARAM_ROLE_POSITIONAL_ONLY = 2;

    • PARAM_ROLE_KEYWORD_ONLY

      public static final StardocOutputProtos.FunctionParamRole PARAM_ROLE_KEYWORD_ONLY
       A keyword-only parameter, i.e. a non-vararg/kwarg parameter that follows
 `*` or `*args` in the function's declaration.
      PARAM_ROLE_KEYWORD_ONLY = 3;

    • PARAM_ROLE_VARARGS

      public static final StardocOutputProtos.FunctionParamRole PARAM_ROLE_VARARGS
       Residual varargs, typically `*args` in the function's declaration.
      PARAM_ROLE_VARARGS = 4;

    • PARAM_ROLE_KWARGS

      public static final StardocOutputProtos.FunctionParamRole PARAM_ROLE_KWARGS
       Residual keyword arguments, typically `**kwargs` in the function's
 declaration.
      PARAM_ROLE_KWARGS = 5;

    • UNRECOGNIZED

      public static final StardocOutputProtos.FunctionParamRole UNRECOGNIZED

  • Field Details

    • PARAM_ROLE_UNSPECIFIED_VALUE

      public static final int PARAM_ROLE_UNSPECIFIED_VALUE
      PARAM_ROLE_UNSPECIFIED = 0;
      See Also:

    • PARAM_ROLE_ORDINARY_VALUE

      public static final int PARAM_ROLE_ORDINARY_VALUE
       An ordinary parameter which may be used as a positional or by keyword.
      PARAM_ROLE_ORDINARY = 1;
      See Also:

    • PARAM_ROLE_POSITIONAL_ONLY_VALUE

      public static final int PARAM_ROLE_POSITIONAL_ONLY_VALUE
       A positional-only parameter; such parameters cannot be defined in pure
 Starlark code, but exist in some natively-defined functions.
      PARAM_ROLE_POSITIONAL_ONLY = 2;
      See Also:

    • PARAM_ROLE_KEYWORD_ONLY_VALUE

      public static final int PARAM_ROLE_KEYWORD_ONLY_VALUE
       A keyword-only parameter, i.e. a non-vararg/kwarg parameter that follows
 `*` or `*args` in the function's declaration.
      PARAM_ROLE_KEYWORD_ONLY = 3;
      See Also:

    • PARAM_ROLE_VARARGS_VALUE

      public static final int PARAM_ROLE_VARARGS_VALUE
       Residual varargs, typically `*args` in the function's declaration.
      PARAM_ROLE_VARARGS = 4;
      See Also:

    • PARAM_ROLE_KWARGS_VALUE

      public static final int PARAM_ROLE_KWARGS_VALUE
       Residual keyword arguments, typically `**kwargs` in the function's
 declaration.
      PARAM_ROLE_KWARGS = 5;
      See Also:

  • Method Details

    • values

      public static StardocOutputProtos.FunctionParamRole[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static StardocOutputProtos.FunctionParamRole valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static StardocOutputProtos.FunctionParamRole valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static StardocOutputProtos.FunctionParamRole forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<StardocOutputProtos.FunctionParamRole> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static StardocOutputProtos.FunctionParamRole valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null