com.sap.client.odata.v4

Class ComplexValue

java.lang.Object

com.sap.client.odata.v4.DataValue

com.sap.client.odata.v4.StructureBase

com.sap.client.odata.v4.ComplexValue

public class ComplexValue
extends StructureBase

Encapsulates an OData complex value.

Field Summary

Fields inherited from class com.sap.client.odata.v4.DataValue

undefined

Constructor Summary

Constructors

Constructor and Description
ComplexValue() See ComplexValue(boolean, ComplexType).
ComplexValue(boolean withDefaults) See ComplexValue(boolean, ComplexType).
ComplexValue(boolean withDefaults, ComplexType type) Construct a new complex value.

Method Summary

Modifier and Type	Method and Description
static ComplexValue	castOptional(DataValue value) For internal use only.
static ComplexValue	castRequired(DataValue value) For internal use only.
ComplexValue	copyComplex() Return a copy of this complex value (only structural properties are copied).
static boolean	equal(ComplexValue a, ComplexValue b) Return true if two complex values have equal structural properties.
ComplexType	getComplexType() The complex type metadata for this value (ComplexValue.dataType cast to ComplexType).
DataType	getDataType() Data type with a DataType.code of DataType.COMPLEX_VALUE.
ComplexValue	getOldComplex() (nullable) Contains the original values for all structural properties of this complex value.
int	getTypeCode() Data type code of the wrapped value, equivalent to dataType.code.
static ComplexValue	ofType(ComplexType type) Construct a new complex value of the specified type.
void	setOldComplex(ComplexValue value) Contains the original values for all structural properties of this complex value.
java.lang.String	toString() Convert this data value to a string.

Methods inherited from class com.sap.client.odata.v4.StructureBase

getDataValue, getDynamic, getDynamicProperties, getOptionalValue, getRequiredValue, getStreamLink, getStructureType, getValuePath, hasDataType, hasDataValue, isProxy, setDataValue, setDefaultValues, setDefaultValues, setDefaultValues, setDynamic, setDynamicProperties, setOptionalValue, setRequiredValue, setValuePath, unsetDataValue

Methods inherited from class com.sap.client.odata.v4.DataValue

cloneMutable, equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplexValue

public ComplexValue()

See ComplexValue(boolean, ComplexType).

ComplexValue

public ComplexValue(boolean withDefaults)

See ComplexValue(boolean, ComplexType).

ComplexValue

public ComplexValue(boolean withDefaults,
                    ComplexType type)

Construct a new complex value. This constructor is intended for use by custom complex value subclasses. Use ComplexValue.ofType for regular construction.

Parameters:

type - (nullable) Complex type. Should not be null except when called by generated proxy base classes.

withDefaults - Should ComplexValue.setDefaultValues be called to initialize properties with default values?

Method Detail

castOptional

public static ComplexValue castOptional(DataValue value)

For internal use only.

castRequired

public static ComplexValue castRequired(DataValue value)

For internal use only.

copyComplex

public ComplexValue copyComplex()

Return a copy of this complex value (only structural properties are copied).

Returns:

A copy of this complex value (only structural properties are copied).

equal

public static boolean equal(ComplexValue a,
                            ComplexValue b)

Return true if two complex values have equal structural properties.

Parameters:

a - (nullable) First complex value.

b - (nullable) Second complex value.

Returns:

true if two complex values have equal structural properties.

getComplexType

public ComplexType getComplexType()

The complex type metadata for this value (ComplexValue.dataType cast to ComplexType).

getDataType

public DataType getDataType()

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

Specified by:

getDataType in class DataValue

getOldComplex

public ComplexValue getOldComplex()

(nullable) Contains the original values for all structural properties of this complex value. Used by DataService.updateEntity to determine the changed properties for PATCH requests.

getTypeCode

public int getTypeCode()

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

Overrides:

getTypeCode in class DataValue

ofType

public static ComplexValue ofType(ComplexType type)

Construct a new complex value of the specified type.

Parameters:

type - Complex type for the new value.

Returns:

A new complex value.

setOldComplex

public void setOldComplex(ComplexValue value)

Contains the original values for all structural properties of this complex value. Used by DataService.updateEntity to determine the changed properties for PATCH requests.

toString

public java.lang.String toString()

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