Package com.google.protobuf
Enum Class Field.Cardinality
- All Implemented Interfaces:
Internal.EnumLite
,ProtocolMessageEnum
,Serializable
,Comparable<Field.Cardinality>
,Constable
- Enclosing class:
Field
Whether a field is optional, required, or repeated.Protobuf enum
google.protobuf.Field.Cardinality
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionFor optional fields.For repeated fields.For required fields.For fields with unknown cardinality. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
For optional fields.static final int
For repeated fields.static final int
For required fields.static final int
For fields with unknown cardinality.private static final Internal.EnumLiteMap
<Field.Cardinality> private final int
private static final Field.Cardinality[]
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Field.Cardinality
forNumber
(int value) static final Descriptors.EnumDescriptor
Return the enum type's descriptor, which contains information about each defined value, etc.final int
Return the value's numeric value as defined in the .proto file.Return the value's descriptor, which contains information such as value name, number, and type.static Field.Cardinality
valueOf
(int value) Deprecated.static Field.Cardinality
Returns the enum constant of this class with the specified name.static Field.Cardinality
Returns the enum constant of this class with the specified name.static Field.Cardinality[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
CARDINALITY_UNKNOWN
For fields with unknown cardinality.
CARDINALITY_UNKNOWN = 0;
-
CARDINALITY_OPTIONAL
For optional fields.
CARDINALITY_OPTIONAL = 1;
-
CARDINALITY_REQUIRED
For required fields. Proto2 syntax only.
CARDINALITY_REQUIRED = 2;
-
CARDINALITY_REPEATED
For repeated fields.
CARDINALITY_REPEATED = 3;
-
UNRECOGNIZED
-
-
Field Details
-
CARDINALITY_UNKNOWN_VALUE
public static final int CARDINALITY_UNKNOWN_VALUEFor fields with unknown cardinality.
CARDINALITY_UNKNOWN = 0;
- See Also:
-
CARDINALITY_OPTIONAL_VALUE
public static final int CARDINALITY_OPTIONAL_VALUEFor optional fields.
CARDINALITY_OPTIONAL = 1;
- See Also:
-
CARDINALITY_REQUIRED_VALUE
public static final int CARDINALITY_REQUIRED_VALUEFor required fields. Proto2 syntax only.
CARDINALITY_REQUIRED = 2;
- See Also:
-
CARDINALITY_REPEATED_VALUE
public static final int CARDINALITY_REPEATED_VALUEFor repeated fields.
CARDINALITY_REPEATED = 3;
- See Also:
-
internalValueMap
-
VALUES
-
value
private final int value
-
-
Constructor Details
-
Cardinality
private Cardinality(int value)
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getNumber
public final int getNumber()Description copied from interface:ProtocolMessageEnum
Return the value's numeric value as defined in the .proto file.- Specified by:
getNumber
in interfaceInternal.EnumLite
- Specified by:
getNumber
in interfaceProtocolMessageEnum
-
valueOf
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 nameNullPointerException
- if the argument is null
-
forNumber
- Parameters:
value
- The numeric wire value of the corresponding enum entry.- Returns:
- The enum associated with the given numeric wire value.
-
internalGetValueMap
-
getValueDescriptor
Description copied from interface:ProtocolMessageEnum
Return the value's descriptor, which contains information such as value name, number, and type.- Specified by:
getValueDescriptor
in interfaceProtocolMessageEnum
-
getDescriptorForType
Description copied from interface:ProtocolMessageEnum
Return the enum type's descriptor, which contains information about each defined value, etc.- Specified by:
getDescriptorForType
in interfaceProtocolMessageEnum
-
getDescriptor
-
valueOf
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 nameNullPointerException
- if the argument is null
-