Package com.sap.cds

Interface CdsList<T extends Map<String,Object>>

All Superinterfaces:

Collection<T>, Iterable<T>, JSONizable, List<T>

public interface CdsList<T extends Map<String,Object>>
extends List<T>, JSONizable

A list of data to be used in Insert, Update and Upsert statements. In deep updates and upserts, nested lists can be marked as a delta representation, which may contain entities that are marked for removal.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CdsList.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final CdsList.Factory	factory

Method Summary

Modifier and Type	Method	Description
static <T extends Map<String, Object>> CdsList<T>	create()	Creates a new instance of CdsList.
static <T extends Map<String, Object>> CdsList<T>	create(List<T> backingList)	Returns a CdsList backed by the given list.
static <T extends Map<String, Object>> CdsList<T>	create(T... entries)	Returns a CdsList with the given entries.
default CdsList<T>	delta()	Marks this list as a delta representation for a nested collection in deep update or upsert data.
static <T extends Map<String, Object>> CdsList<T>	delta(T... deltaEntries)	Returns a delta CdsList with the given entries.
boolean	isDelta()	Indicates if this list is marked as a delta representation for a nested collection in deep update or upsert data
void	setDelta(boolean delta)	Marks or unmarks this list as a delta representation for a nested collection in deep update or upsert data.

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface com.sap.cds.JSONizable

toJson

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Field Details

factory

static final CdsList.Factory factory

Method Details

create

static <T extends Map<String,
Object>> CdsList<T> create()

Creates a new instance of CdsList.

Returns:

an empty CdsList

create

@SafeVarargs
static <T extends Map<String,
Object>> CdsList<T> create(T... entries)

Returns a CdsList with the given entries.

Parameters:

entries - the list entries

Returns:

a CdsList with the given entries

delta

@SafeVarargs
static <T extends Map<String,
Object>> CdsList<T> delta(T... deltaEntries)

Returns a delta CdsList with the given entries.

Parameters:

deltaEntries - the delta list entries

Returns:

a delta CdsList with the given entries

create

static <T extends Map<String,
Object>> CdsList<T> create(List<T> backingList)

Returns a CdsList backed by the given list.

Parameters:

backingList - the backing list

Returns:

a CdsList backed by backingList

delta

default CdsList<T> delta()

Marks this list as a delta representation for a nested collection in deep update or upsert data.

Returns:

this list instance

setDelta

void setDelta(boolean delta)

Marks or unmarks this list as a delta representation for a nested collection in deep update or upsert data.

Parameters:

delta - true to mark as delta, false to unmark

isDelta

boolean isDelta()

Indicates if this list is marked as a delta representation for a nested collection in deep update or upsert data

Returns:

true if this instance if marked as delta