Package org.yamcs.api

Enum Class FieldBehavior

java.lang.Object

java.lang.Enum<FieldBehavior>

org.yamcs.api.FieldBehavior

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<FieldBehavior>, Constable

public enum FieldBehavior
extends Enum<FieldBehavior>
implements com.google.protobuf.ProtocolMessageEnum

Protobuf enum yamcs.api.FieldBehavior

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIELD_BEHAVIOR_UNSPECIFIED	Default.
SECRET	Marks a field as secret.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FIELD_BEHAVIOR_UNSPECIFIED_VALUE	Default.
static final int	SECRET_VALUE	Marks a field as secret.

Method Summary

Modifier and Type	Method	Description
static FieldBehavior	forNumber(int value)
static final com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
final com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
final int	getNumber()
final com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<FieldBehavior>	internalGetValueMap()
static FieldBehavior	valueOf(int value)	Deprecated.
static FieldBehavior	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this class with the specified name.
static FieldBehavior	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FieldBehavior[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FIELD_BEHAVIOR_UNSPECIFIED

public static final FieldBehavior FIELD_BEHAVIOR_UNSPECIFIED

 Default. Do not use.
 

FIELD_BEHAVIOR_UNSPECIFIED = 0;

SECRET

public static final FieldBehavior SECRET

 Marks a field as secret. Services, such as audit logging, may use
 this as a hint for masking or hiding this field.
 

SECRET = 1;

Field Details

FIELD_BEHAVIOR_UNSPECIFIED_VALUE

public static final int FIELD_BEHAVIOR_UNSPECIFIED_VALUE

 Default. Do not use.
 

FIELD_BEHAVIOR_UNSPECIFIED = 0;

See Also:

• Constant Field Values

SECRET_VALUE

public static final int SECRET_VALUE

 Marks a field as secret. Services, such as audit logging, may use
 this as a hint for masking or hiding this field.
 

SECRET = 1;

See Also:

• Constant Field Values

Method Details

values

public static FieldBehavior[] 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 FieldBehavior 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 FieldBehavior 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 FieldBehavior 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<FieldBehavior> 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 FieldBehavior 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