com.sap.cloud.server.odata

Class EnumValue

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.EnumValue

public class EnumValue
extends DataValue

Encapsulates an OData enum value.

Field Summary

Fields inherited from class com.sap.cloud.server.odata.DataValue

undefined

Constructor Summary

Constructors

Constructor and Description
EnumValue(long num, java.lang.String str, EnumType type) For internal use only.

Method Summary

Modifier and Type	Method and Description
byte	byteValue() Return the numeric value of this enum value as a byte.
static EnumValue	castOptional(DataValue value) For internal use only.
static EnumValue	castRequired(DataValue value) For internal use only.
static int	compare(EnumValue x, EnumValue y) Compare two wrapped values for ordering.
static boolean	equal(EnumValue x, EnumValue y) Compare two wrapped values for equality.
Annotation	getAnnotation(java.lang.String term) Lookup an existing annotation by term name, or throw an exception if the annotation is not found.
AnnotationMap	getAnnotations() Return map of annotations for this model element.
boolean	getCanBeRemoved() Return can this model element be removed by DataService.refreshMetadata.
DataType	getDataType() Return data type with a DataType.code of DataType.ENUM_VALUE.
EnumType	getEnumType() Return the enum type metadata for this value (EnumValue.dataType cast to EnumType).
java.lang.String	getName() Return name of this enumeration member.
int	getSourceLine() Return source line number for this schema element within its defining schema.
DataValue	getValue() Return the numeric value of this enum value as a ByteValue, ShortValue, IntValue, LongValue, UnsignedByte or UnsignedShort (depending on the enum type's underlying type).
int	intValue() Return the numeric value of this enum value as an int.
boolean	isExtension() Return true if this member was added since metadata was originally loaded.
boolean	isRemoved() Return has this model element been removed by a successful call to DataService.refreshMetadata? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.
long	longValue() Return the numeric value of this enum value as a long.
void	setCanBeRemoved(boolean value) Set can this model element be removed by DataService.refreshMetadata.
void	setExtension(boolean value) Set true if this member was added since metadata was originally loaded.
void	setRemoved(boolean value) Set has this model element been removed by a successful call to DataService.refreshMetadata? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.
void	setSourceLine(int value) Set source line number for this schema element within its defining schema.
short	shortValue() Return the numeric value of this enum value as a short.
java.lang.String	toString() Convert this data value to a string.

Methods inherited from class com.sap.cloud.server.odata.DataValue

cloneMutable, equals, getTypeCode, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnumValue

public EnumValue(long num,
                 java.lang.String str,
                 EnumType type)

For internal use only.

Parameters:

num - (internal use only)

str - (internal use only)

type - (internal use only)

Method Detail

byteValue

public byte byteValue()

Return the numeric value of this enum value as a byte.

Returns:

The numeric value of this enum value as a byte.

castOptional

public static EnumValue castOptional(DataValue value)

For internal use only.

Parameters:

value - (internal use only)

Returns:

(internal use only)

castRequired

public static EnumValue castRequired(DataValue value)

For internal use only.

Parameters:

value - (internal use only)

Returns:

(internal use only)

compare

public static int compare(EnumValue x,
                          EnumValue y)

Compare two wrapped values for ordering.

Parameters:

x - First object for comparison.

y - Second object for comparison.

Returns:

-1 if x.value < y.value, 0 if x.value == y.value, or 1 if x.value > y.value.

equal

public static boolean equal(EnumValue x,
                            EnumValue y)

Compare two wrapped values for equality.

Parameters:

x - (nullable) First object for comparison.

y - (nullable) Second object for comparison.

Returns:

true if x.value == y.value or if both arguments are null, otherwise false.

getAnnotation

public Annotation getAnnotation(java.lang.String term)

Lookup an existing annotation by term name, or throw an exception if the annotation is not found.

See Also:

EnumValue.annotations and AnnotationMap.get, for looking up annotations that might not exist.

Parameters:

term - The term name.

Returns:

The annotation.

getAnnotations

public AnnotationMap getAnnotations()

Return map of annotations for this model element. For annotations without qualifiers, the entry key is the annotation term name. For annotations with qualifiers, the entry key is the annotation term name, then "#", then the annotation qualifier.

See Also:

Annotation, AnnotationTerm.

Returns:

Map of annotations for this model element.

getCanBeRemoved

public boolean getCanBeRemoved()

Return can this model element be removed by DataService.refreshMetadata. Defaults to false. Set this to true to indicate that the application is coded to be able able to function correctly without this model element.

See Also:

EnumValue.isRemoved.

Returns:

Can this model element be removed by `DataService.refreshMetadata`. Defaults to `false`.

getDataType

public DataType getDataType()

Return data type with a DataType.code of DataType.ENUM_VALUE.

Specified by:

getDataType in class DataValue

Returns:

Data type with a DataType.code of DataType.ENUM_VALUE.

getEnumType

public EnumType getEnumType()

Return the enum type metadata for this value (EnumValue.dataType cast to EnumType).

Returns:

The enum type metadata for this value (EnumValue.dataType cast to EnumType).

getName

public java.lang.String getName()

Return name of this enumeration member.

Returns:

Name of this enumeration member.

getSourceLine

public int getSourceLine()

Return source line number for this schema element within its defining schema.

Returns:

Source line number for this schema element within its defining schema.

getValue

public DataValue getValue()

Return the numeric value of this enum value as a ByteValue, ShortValue, IntValue, LongValue, UnsignedByte or UnsignedShort (depending on the enum type's underlying type).

Returns:

The numeric value of this enum value as a ByteValue, ShortValue, IntValue, LongValue, UnsignedByte or UnsignedShort (depending on the enum type's underlying type).

intValue

public int intValue()

Return the numeric value of this enum value as an int.

Returns:

The numeric value of this enum value as an int.

isExtension

public boolean isExtension()

Return true if this member was added since metadata was originally loaded.

Returns:

True if this member was added since metadata was originally loaded.

isRemoved

public boolean isRemoved()

Return has this model element been removed by a successful call to DataService.refreshMetadata? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.

See Also:

EnumValue.canBeRemoved.

Returns:

Has this model element been removed by a successful call to `DataService.refreshMetadata`?

longValue

public long longValue()

Return the numeric value of this enum value as a long.

Returns:

The numeric value of this enum value as a long.

setCanBeRemoved

public void setCanBeRemoved(boolean value)

Set can this model element be removed by DataService.refreshMetadata. Defaults to false. Set this to true to indicate that the application is coded to be able able to function correctly without this model element.

See Also:

EnumValue.isRemoved.

Parameters:

value - Can this model element be removed by `DataService.refreshMetadata`. Defaults to `false`.

setExtension

public void setExtension(boolean value)

Set true if this member was added since metadata was originally loaded.

Parameters:

value - True if this member was added since metadata was originally loaded.

setRemoved

public void setRemoved(boolean value)

Set has this model element been removed by a successful call to DataService.refreshMetadata? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.

See Also:

EnumValue.canBeRemoved.

Parameters:

value - Has this model element been removed by a successful call to `DataService.refreshMetadata`?

setSourceLine

public void setSourceLine(int value)

Set source line number for this schema element within its defining schema.

Parameters:

value - Source line number for this schema element within its defining schema.

shortValue

public short shortValue()

Return the numeric value of this enum value as a short.

Returns:

The numeric value of this enum value as a short.

toString

public java.lang.String toString()

Convert this data value to a string. If the EnumValue.dataType is defined by XML Schema Part 2: Datatypes, then the corresponding lexical format is used. JSON format is used for structured values (arrays and objects).

Specified by:

toString in class DataValue

Returns:

Lexical representation of this data value.