Java Reference
Java Reference
Detailed Description
A "three-way" boolean: unspecified, false or true. We don't use the value of 1 to increase the chance to catch bugs: eg. in python, a user may set a proto field of this type enum to a boolean value without type checks, if they set it to True, the proto validity code will catch it (because it'll be cast to 1, which is an invalid enum value). Note that if the user sets if to False (i.e. 0), it will be caught by the routing library's parameter validity check too.
Protobuf enum
Definition at line 19 of file OptionalBoolean.java.
Public Member Functions | |
| final int | getNumber () |
| final com.google.protobuf.Descriptors.EnumValueDescriptor | getValueDescriptor () |
| final com.google.protobuf.Descriptors.EnumDescriptor | getDescriptorForType () |
Static Public Member Functions | |
| .lang.Deprecated static OptionalBoolean | valueOf (int value) |
| static OptionalBoolean | forNumber (int value) |
| static com.google.protobuf.Internal.EnumLiteMap< OptionalBoolean > | internalGetValueMap () |
| static final com.google.protobuf.Descriptors.EnumDescriptor | getDescriptor () |
| static OptionalBoolean | valueOf (com.google.protobuf.Descriptors.EnumValueDescriptor desc) |
Public Attributes | |
| BOOL_UNSPECIFIED =(0) | |
BOOL_UNSPECIFIED = 0; More... | |
| BOOL_FALSE =(2) | |
BOOL_FALSE = 2; More... | |
| BOOL_TRUE =(3) | |
BOOL_TRUE = 3; More... | |
| UNRECOGNIZED =(-1) | |
Static Public Attributes | |
| static final int | BOOL_UNSPECIFIED_VALUE = 0 |
BOOL_UNSPECIFIED = 0; More... | |
| static final int | BOOL_FALSE_VALUE = 2 |
BOOL_FALSE = 2; More... | |
| static final int | BOOL_TRUE_VALUE = 3 |
BOOL_TRUE = 3; More... | |
Member Function Documentation
◆ forNumber()
|
inlinestatic |
- Parameters
-
value The numeric wire value of the corresponding enum entry.
- Returns
- The enum associated with the given numeric wire value.
Definition at line 72 of file OptionalBoolean.java.
◆ getDescriptor()
|
inlinestatic |
Definition at line 106 of file OptionalBoolean.java.
◆ getDescriptorForType()
|
inline |
Definition at line 102 of file OptionalBoolean.java.
◆ getNumber()
|
inline |
Definition at line 50 of file OptionalBoolean.java.
◆ getValueDescriptor()
|
inline |
Definition at line 94 of file OptionalBoolean.java.
◆ internalGetValueMap()
|
inlinestatic |
Definition at line 82 of file OptionalBoolean.java.
◆ valueOf() [1/2]
|
inlinestatic |
Definition at line 112 of file OptionalBoolean.java.
◆ valueOf() [2/2]
|
inlinestatic |
- Parameters
-
value The numeric wire value of the corresponding enum entry.
- Returns
- The enum associated with the given numeric wire value.
- Deprecated:
- Use forNumber(int) instead.
Definition at line 64 of file OptionalBoolean.java.
Member Data Documentation
◆ BOOL_FALSE
| BOOL_FALSE =(2) |
BOOL_FALSE = 2;
Definition at line 28 of file OptionalBoolean.java.
◆ BOOL_FALSE_VALUE
|
static |
BOOL_FALSE = 2;
Definition at line 43 of file OptionalBoolean.java.
◆ BOOL_TRUE
| BOOL_TRUE =(3) |
BOOL_TRUE = 3;
Definition at line 32 of file OptionalBoolean.java.
◆ BOOL_TRUE_VALUE
|
static |
BOOL_TRUE = 3;
Definition at line 47 of file OptionalBoolean.java.
◆ BOOL_UNSPECIFIED
| BOOL_UNSPECIFIED =(0) |
BOOL_UNSPECIFIED = 0;
Definition at line 24 of file OptionalBoolean.java.
◆ BOOL_UNSPECIFIED_VALUE
|
static |
BOOL_UNSPECIFIED = 0;
Definition at line 39 of file OptionalBoolean.java.
◆ UNRECOGNIZED
| UNRECOGNIZED =(-1) |
Definition at line 33 of file OptionalBoolean.java.
The documentation for this enum was generated from the following file: