Package com.storedobject.core

Interface EditableList<T>

Type Parameters:

T - Type of items in the list.

All Known Subinterfaces:

LinkValue<T>, StoredObjectLink<T>

All Known Implementing Classes:

ContactData, ExtraInfoValue, StoredObjectLink.Copy, StreamAttachmentData

public interface EditableList<T>

API for an "editable list".

Author:

Syam

Method Summary

Modifier and Type	Method	Description
default void	add(int index, T item)	Aad a new item to the list.
boolean	add(T item)	Aad a new item to the list.
default void	append(Iterable<T> items)	Append items to the list.
boolean	append(T item)	Append an item to the list.
boolean	contains(Object item)	Check whether the given item is in this list or not.
boolean	delete(T item)	Delete an item from the list.
default <R> T	getDuplicate(Function<T,R> value)	Get a duplicate entry.
boolean	isAdded(T item)	Check if the given item was added to the list or not.
boolean	isDeleted(T item)	Check if the given item was deleted from the list or not.
boolean	isEdited(T item)	Check if the given item was edited or not.
default boolean	isSavePending()	Is save pending?
int	size()	Size of the list (including all items).
default Stream<T>	stream()	Get a stream of all items remaining (after removing deleted items).
default Stream<T>	streamAdded()	Get a stream of all newly added items.
Stream<T>	streamAll()	Get a stream of all items (including original, added, deleted and edited items).
default Stream<T>	streamDeleted()	Get a stream of all deleted items.
default Stream<T>	streamEdited()	Get a stream of all modified items.
boolean	undelete(T item)	Undelete an item that was deleted earlier.
boolean	update(T item)	Update an item.

Method Details

contains

boolean contains(Object item)

Check whether the given item is in this list or not. (Note: The parameter is generic Object type to make it compatible with Java's List interface).

Parameters:

item - Item to check.

Returns:

True/false.

isAdded

boolean isAdded(T item)

Check if the given item was added to the list or not.

Parameters:

item - Item to check.

Returns:

True/false.

isDeleted

boolean isDeleted(T item)

Check if the given item was deleted from the list or not.

Parameters:

item - Item to check.

Returns:

True/false.

isEdited

boolean isEdited(T item)

Check if the given item was edited or not.

Parameters:

item - Item to check.

Returns:

True/false.

streamAll

Stream<T> streamAll()

Get a stream of all items (including original, added, deleted and edited items).

Returns:

Stream of items.

stream

default Stream<T> stream()

Get a stream of all items remaining (after removing deleted items).

Returns:

Stream of items.

streamAdded

default Stream<T> streamAdded()

Get a stream of all newly added items.

Returns:

Stream of items.

streamEdited

default Stream<T> streamEdited()

Get a stream of all modified items.

Returns:

Stream of items.

streamDeleted

default Stream<T> streamDeleted()

Get a stream of all deleted items.

Returns:

Stream of items.

size

int size()

Size of the list (including all items).

Returns:

Size.

append

boolean append(T item)

Append an item to the list. This is not considered as a new item.

Parameters:

item - Item to append.

Returns:

True if appended, otherwise, false.

append

default void append(Iterable<T> items)

Append items to the list. This is not considered as new items.

Parameters:

items - Items to append.

add

default void add(int index,
 T item)

Aad a new item to the list. (Note: This doesn't return a result to make it compatible with Java's List interface).

Parameters:

index - Index at which the item needs to be inserted.

item - Item to add.

add

boolean add(T item)

Aad a new item to the list.

Parameters:

item - Item to add.

Returns:

True if added, otherwise, false.

delete

boolean delete(T item)

Delete an item from the list. (If the item was newly added, it will be removed).

Parameters:

item - Item to delete.

Returns:

True if deleted, otherwise, false.

undelete

boolean undelete(T item)

Undelete an item that was deleted earlier.

Parameters:

item - Item to undelete.

Returns:

True if undeleted, otherwise, false.

update

boolean update(T item)

Update an item. Item will be marked as modified.

Parameters:

item - Updated item.

Returns:

True if updated, otherwise, false.

isSavePending

default boolean isSavePending()

Is save pending? (Some entry has "edited" or "deleted" status).

Returns:

True/false.

getDuplicate

default <R> T getDuplicate(Function<T,R> value)

Get a duplicate entry. A function to extract the duplicate value must be passed as the parameter.

E.g., from a list of persons, we want to find out a an entry with duplicate "First Name" (to be compared ignoring case):

getDuplicate(p -> p.getFirstName().toUpperCase());

Note: null values are ignored.

Type Parameters:

R - Type of the duplicate value.

Parameters:

value - Function to extract the duplicate value.

Returns:

Duplicate entry if found, otherwise null.