com.sap.cloud.server.odata

Class StringValue

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.StringValue

public class StringValue
extends DataValue

DataValue subclass that wraps a StringValue.value of type string.

Field Summary

Fields

Modifier and Type	Field and Description
static StringValue	empty

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

undefined

Method Summary

Modifier and Type	Method and Description
static int	compare(StringValue left, StringValue right) Compare two wrapped values for ordering.
static boolean	equal(StringValue left, StringValue right) Compare two wrapped values for equality.
boolean	equals(java.lang.Object value) Return true if this object is equal to value.
DataType	getDataType() Return the type BasicType.STRING.
int	getTypeCode() Return data type code of the wrapped value, equivalent to dataType.code.
java.lang.String	getValue() Return the wrapped value.
int	hashCode() Hash the wrapped value to a number.
static StringValue	of(java.lang.String value) Wrap a string value as an object.
static StringValue	ofNullable(java.lang.String value) Wrap a nullable string value as an object.
static java.lang.String	toNullable(java.lang.Object value) Convert a wrapped string value to a nullable string.
java.lang.String	toString() Convert this data value to a string.
static java.lang.String	unwrap(java.lang.Object value) Convert a wrapped string value to a string.

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

cloneMutable

Methods inherited from class java.lang.Object

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

Field Detail

empty

public static final StringValue empty

Method Detail

compare

public static int compare(StringValue left,
                          StringValue right)

Compare two wrapped values for ordering.

Parameters:

left - First object for comparison.

right - Second object for comparison.

Returns:

-1 if left.value < right.value, 0 if left.value == right.value, or 1 if left.value > right.value.

equal

public static boolean equal(StringValue left,
                            StringValue right)

Compare two wrapped values for equality.

Parameters:

left - (nullable) First object for comparison.

right - (nullable) Second object for comparison.

Returns:

true if left.value == right.value or if both arguments are null, otherwise false.

equals

public boolean equals(java.lang.Object value)

Return true if this object is equal to value.

Overrides:

equals in class DataValue

Parameters:

value - (nullable) The value to compare with.

Returns:

true if this object is equal to value.

getDataType

public DataType getDataType()

Return the type BasicType.STRING.

Specified by:

getDataType in class DataValue

Returns:

The type BasicType.STRING.

getTypeCode

public int getTypeCode()

Return data type code of the wrapped value, equivalent to dataType.code.

Overrides:

getTypeCode in class DataValue

Returns:

Data type code of the wrapped value, equivalent to dataType.code.

getValue

public java.lang.String getValue()

Return the wrapped value.

Returns:

The wrapped value.

hashCode

public int hashCode()

Hash the wrapped value to a number.

Overrides:

hashCode in class DataValue

Returns:

Any value in the range of type int.

of

public static StringValue of(java.lang.String value)

Wrap a string value as an object.

Parameters:

value - Value to be wrapped.

Returns:

The wrapped value.

ofNullable

public static StringValue ofNullable(java.lang.String value)

Wrap a nullable string value as an object.

Parameters:

value - (nullable) Value to be wrapped.

Returns:

(nullable) The wrapped value.

toNullable

public static java.lang.String toNullable(java.lang.Object value)

Convert a wrapped string value to a nullable string.

Throws:

CastException if value is not a wrapped string or null.

Parameters:

value - (nullable) The wrapped value.

Returns:

(nullable) A nullable string.

toString

public java.lang.String toString()

Convert this data value to a string. If the StringValue.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.

unwrap

public static java.lang.String unwrap(java.lang.Object value)

Convert a wrapped string value to a string.

Throws:

CastException if value is not a wrapped string.

Parameters:

value - (nullable) The wrapped value.

Returns:

A string.