Package com.google.protobuf
Enum Field.Cardinality
- java.lang.Object
-
- java.lang.Enum<Field.Cardinality>
-
- com.google.protobuf.Field.Cardinality
-
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,java.io.Serializable,java.lang.Comparable<Field.Cardinality>
- Enclosing class:
- Field
public static enum Field.Cardinality extends java.lang.Enum<Field.Cardinality> implements com.google.protobuf.ProtocolMessageEnum
Whether a field is optional, required, or repeated.
Protobuf enumgoogle.protobuf.Field.Cardinality
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CARDINALITY_OPTIONALFor optional fields.CARDINALITY_REPEATEDFor repeated fields.CARDINALITY_REQUIREDFor required fields.CARDINALITY_UNKNOWNFor fields with unknown cardinality.UNRECOGNIZED
-
Field Summary
Fields Modifier and Type Field Description static intCARDINALITY_OPTIONAL_VALUEFor optional fields.static intCARDINALITY_REPEATED_VALUEFor repeated fields.static intCARDINALITY_REQUIRED_VALUEFor required fields.static intCARDINALITY_UNKNOWN_VALUEFor fields with unknown cardinality.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static Field.CardinalityforNumber(int value)static com.google.protobuf.Descriptors.EnumDescriptorgetDescriptor()com.google.protobuf.Descriptors.EnumDescriptorgetDescriptorForType()intgetNumber()com.google.protobuf.Descriptors.EnumValueDescriptorgetValueDescriptor()static com.google.protobuf.Internal.EnumLiteMap<Field.Cardinality>internalGetValueMap()static Field.CardinalityvalueOf(int value)Deprecated.static Field.CardinalityvalueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)Returns the enum constant of this type with the specified name.static Field.CardinalityvalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static Field.Cardinality[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
CARDINALITY_UNKNOWN
public static final Field.Cardinality CARDINALITY_UNKNOWN
For fields with unknown cardinality.
CARDINALITY_UNKNOWN = 0;
-
CARDINALITY_OPTIONAL
public static final Field.Cardinality CARDINALITY_OPTIONAL
For optional fields.
CARDINALITY_OPTIONAL = 1;
-
CARDINALITY_REQUIRED
public static final Field.Cardinality CARDINALITY_REQUIRED
For required fields. Proto2 syntax only.
CARDINALITY_REQUIRED = 2;
-
CARDINALITY_REPEATED
public static final Field.Cardinality CARDINALITY_REPEATED
For repeated fields.
CARDINALITY_REPEATED = 3;
-
UNRECOGNIZED
public static final Field.Cardinality UNRECOGNIZED
-
-
Field Detail
-
CARDINALITY_UNKNOWN_VALUE
public static final int CARDINALITY_UNKNOWN_VALUE
For fields with unknown cardinality.
CARDINALITY_UNKNOWN = 0;- See Also:
- Constant Field Values
-
CARDINALITY_OPTIONAL_VALUE
public static final int CARDINALITY_OPTIONAL_VALUE
For optional fields.
CARDINALITY_OPTIONAL = 1;- See Also:
- Constant Field Values
-
CARDINALITY_REQUIRED_VALUE
public static final int CARDINALITY_REQUIRED_VALUE
For required fields. Proto2 syntax only.
CARDINALITY_REQUIRED = 2;- See Also:
- Constant Field Values
-
CARDINALITY_REPEATED_VALUE
public static final int CARDINALITY_REPEATED_VALUE
For repeated fields.
CARDINALITY_REPEATED = 3;- See Also:
- Constant Field Values
-
-
Method Detail
-
values
public static Field.Cardinality[] 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 (Field.Cardinality c : Field.Cardinality.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Field.Cardinality 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 namejava.lang.NullPointerException- if the argument is null
-
getNumber
public final int getNumber()
- Specified by:
getNumberin interfacecom.google.protobuf.Internal.EnumLite- Specified by:
getNumberin interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
@Deprecated public static Field.Cardinality valueOf(int value)
Deprecated.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:
value- 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 namejava.lang.NullPointerException- if the argument is null
-
forNumber
public static Field.Cardinality 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<Field.Cardinality> internalGetValueMap()
-
getValueDescriptor
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
- Specified by:
getValueDescriptorin interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
-
valueOf
public static Field.Cardinality valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
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:
desc- 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 namejava.lang.NullPointerException- if the argument is null
-
-