Package com.google.protobuf

Enum Field.Cardinality

java.lang.Object

java.lang.Enum<Field.Cardinality>

com.google.protobuf.Field.Cardinality

All Implemented Interfaces:

Internal.EnumLite, ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<Field.Cardinality>

Enclosing class:

Field

public static enum Field.Cardinality
extends java.lang.Enum<Field.Cardinality>
implements ProtocolMessageEnum

 Whether a field is optional, required, or repeated.
 

Protobuf enum google.protobuf.Field.Cardinality

Enum Constant Summary

Enum Constants

Enum Constant	Description
CARDINALITY_OPTIONAL	For optional fields.
CARDINALITY_REPEATED	For repeated fields.
CARDINALITY_REQUIRED	For required fields.
CARDINALITY_UNKNOWN	For fields with unknown cardinality.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static int	CARDINALITY_OPTIONAL_VALUE	For optional fields.
static int	CARDINALITY_REPEATED_VALUE	For repeated fields.
static int	CARDINALITY_REQUIRED_VALUE	For required fields.
static int	CARDINALITY_UNKNOWN_VALUE	For fields with unknown cardinality.

Method Summary

Modifier and Type	Method	Description
static Field.Cardinality	forNumber(int value)
static Descriptors.EnumDescriptor	getDescriptor()
Descriptors.EnumDescriptor	getDescriptorForType()	Return the enum type's descriptor, which contains information about each defined value, etc.
int	getNumber()	Return the value's numeric value as defined in the .proto file.
Descriptors.EnumValueDescriptor	getValueDescriptor()	Return the value's descriptor, which contains information such as value name, number, and type.
static Internal.EnumLiteMap<Field.Cardinality>	internalGetValueMap()
static Field.Cardinality	valueOf(int value)	Deprecated.
static Field.Cardinality	valueOf(Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static Field.Cardinality	valueOf(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.

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

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 name

java.lang.NullPointerException - 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 interface Internal.EnumLite

Specified by:

getNumber in interface 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 name

java.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 Internal.EnumLiteMap<Field.Cardinality> internalGetValueMap()

getValueDescriptor

public final Descriptors.EnumValueDescriptor 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 interface ProtocolMessageEnum

getDescriptorForType

public final Descriptors.EnumDescriptor getDescriptorForType()

Description copied from interface: ProtocolMessageEnum

Return the enum type's descriptor, which contains information about each defined value, etc.

Specified by:

getDescriptorForType in interface ProtocolMessageEnum

getDescriptor

public static final Descriptors.EnumDescriptor getDescriptor()

valueOf

public static Field.Cardinality valueOf(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 name

java.lang.NullPointerException - if the argument is null