com.sap.cloud.server.odata

Class ListBase

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.ListBase

Direct Known Subclasses:

AggregateExpressionList, AggregateFromList, AggregateValueList, AnnotationList, AnnotationMap.EntryList, AnnotationTermList, AnnotationTermMap.EntryList, AnyList, AnyMap.EntryList, BinaryList, BooleanList, ByteList, ChangedLinkList, CharList, ComplexTypeList, ComplexTypeMap.EntryList, ComplexValueList, ComplexValueListWithNulls, ComplexValueMap.EntryList, CsdlReference.IncludeList, CsdlReferenceList, CustomPathList, DataMethodList, DataMethodMap.EntryList, DataMetricList, DataMetricMap.EntryList, DataSchemaList, DataSchemaMap.EntryList, DataTypeList, DataTypeMap.EntryList, DataValueList, DataValueListWithNulls, DataValueMap.EntryList, DayTimeDurationList, DecimalList, DoubleList, EntityContainerList, EntityContainerMap.EntryList, EntitySet.IndexList, EntitySetList, EntitySetMap.EntryList, EntityTypeList, EntityTypeMap.EntryList, EntityValueList, EntityValueListWithNulls, EntityValueMap.EntryList, EnumTypeList, EnumTypeMap.EntryList, EnumValueList, EnumValueMap.EntryList, ErrorResponseList, ExpandItemList, FloatList, GeographyValueList, GeometryValueList, GlobalDateTimeList, GuidValueList, IntegerList, IntList, JsonObject.EntryList, LineStringCoordinates, LocalDateList, LocalDateTimeList, LocalTimeList, LongList, MimePartList, MultiLineStringCoordinates, MultiPointCoordinates, MultiPolygonCoordinates, ObjectList, ObjectMap.EntryList, ParameterList, PathAnnotationsList, PathAnnotationsMap.EntryList, PendingRequestList, PointCoordinates, PolygonCoordinates, PropertyList, PropertyMap.EntryList, PropertyPathList, QueryFunctionList, QueryFunctionMap.EntryList, QueryOperatorList, QueryOperatorMap.EntryList, SelectItemList, ShortList, SimpleTypeList, SimpleTypeMap.EntryList, SortItemList, StringList, StringMap.EntryList, StructureTypeList, StructureTypeMap.EntryList, TransformValueList, UnsignedByteList, UnsignedShortList, XmlAttributeList, XmlCommentList, XmlElementList, XmlElementMap.EntryList, XmlNameList, XmlNodeList, XmlProcessingInstructionList, YearMonthDurationList

public abstract class ListBase
extends DataValue

Base class for strongly-typed lists.

Field Summary

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

undefined

Constructor Summary

Constructors

Constructor and Description
ListBase(int capacity) Construct a new list with a ListBase.length of zero and specified initial capacity.

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all items from this list.
com.sap.cloud.server.odata.core.Comparer	getComparer() Return an ordering function for the item type of this list.
DataType	getDataType() Return the data type for this list.
com.sap.cloud.server.odata.core.Equality	getEquality() Return an equality function for the item type of this list.
com.sap.cloud.server.odata.core.UntypedList	getUntypedList() Return the underlying untyped list.
boolean	isEmpty() Return true if this list contains no items.
int	length() Return the number of items in this list.
void	removeAt(int index) Remove an item from the specified index in this list.
void	removeFirst() Remove the first item (if any) from this list.
void	removeLast() Remove the last item (if any) from this list.
void	removeRange(int start, int end) Remove a range of items from this list.
void	reverse() Reverse the order of the items in this list.
void	shareWith(ListBase other, boolean replace) For internal use only.
void	sort() Sort the items in this list, using the ListBase.comparer property for ordering.
void	sortWith(com.sap.cloud.server.odata.core.Comparer comparer) Sort the items in this list.
ListBase	toDynamic() Return (nullable) a dynamic representation of this list (DataValueList, ComplexValueList, or EntityValueList), or null if there is no dynamic representation available.
java.lang.String	toString() Return a string representation of this list.
java.lang.Object	validate(java.lang.Object value) Base function for validating the item's value before adding it to the list.

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

ListBase

public ListBase(int capacity)

Construct a new list with a ListBase.length of zero and specified initial capacity. A list can expand in length beyond its initial capacity, but best performance will be obtained if the initial capacity is close to the list's maximum length.

Parameters:

capacity - Initial capacity.

Method Detail

clear

public void clear()

Remove all items from this list.

getComparer

public com.sap.cloud.server.odata.core.Comparer getComparer()

Return an ordering function for the item type of this list.

Returns:

An ordering function for the item type of this list.

getDataType

public DataType getDataType()

Return the data type for this list.

Specified by:

getDataType in class DataValue

Returns:

The data type for this list.

getEquality

public com.sap.cloud.server.odata.core.Equality getEquality()

Return an equality function for the item type of this list.

Returns:

An equality function for the item type of this list.

getUntypedList

public com.sap.cloud.server.odata.core.UntypedList getUntypedList()

Return the underlying untyped list. Use with care, avoiding the addition of objects with an incorrect item type.

Returns:

The underlying untyped list. Use with care, avoiding the addition of objects with an incorrect item type.

isEmpty

public boolean isEmpty()

Return true if this list contains no items.

Returns:

true if this list contains no items.

length

public int length()

Return the number of items in this list.

Returns:

The number of items in this list.

removeAt

public void removeAt(int index)

Remove an item from the specified index in this list.

Parameters:

index - Index of the item to be removed.

removeFirst

public void removeFirst()

Remove the first item (if any) from this list.

removeLast

public void removeLast()

Remove the last item (if any) from this list.

removeRange

public void removeRange(int start,
                        int end)

Remove a range of items from this list.

Parameters:

start - Starting index (inclusive) for items to be removed.

end - Ending index (exclusive) for items to be removed.

reverse

public void reverse()

Reverse the order of the items in this list.

shareWith

public void shareWith(ListBase other,
                      boolean replace)

For internal use only.

Parameters:

other - (internal use only)

replace - (internal use only)

sort

public void sort()

Sort the items in this list, using the ListBase.comparer property for ordering.

sortWith

public void sortWith(com.sap.cloud.server.odata.core.Comparer comparer)

Sort the items in this list.

Parameters:

comparer - Comparer for ordering.

toDynamic

public ListBase toDynamic()

Return (nullable) a dynamic representation of this list (DataValueList, ComplexValueList, or EntityValueList), or null if there is no dynamic representation available.

Returns:

(nullable) a dynamic representation of this list (DataValueList, ComplexValueList, or EntityValueList), or null if there is no dynamic representation available.

toString

public java.lang.String toString()

Return a string representation of this list.

Specified by:

toString in class DataValue

Returns:

a string representation of this list.

validate

public java.lang.Object validate(java.lang.Object value)

Base function for validating the item's value before adding it to the list. Validate is needed in some ListBase types, for exampe in the case of ByteList, where a value out of the ByteValue type's valid range can be added, because ByteList accepts Int instead of Byte. With a proper overwrite of this function in the given BaseList class ensures, that only a valid value Int (-128 - +127 in this case) can be added to the list.

Parameters:

value - (nullable) The value to be validated.

Returns:

(nullable) The value without modification.