com.hpe.caf.worker.document.model

Interface Subdocuments

All Superinterfaces:

DocumentWorkerObject, Iterable<Subdocument>

public interface Subdocuments
extends DocumentWorkerObject, Iterable<Subdocument>

Represents the list of subdocuments that are attached to a document.

Method Summary

Modifier and Type	Method and Description
Subdocument	add(String reference) Creates a new subdocument and adds it to the collection.
Subdocument	get(int index) Retrieves the subdocument at the specified position.
Document	getDocument() Returns the document that this collection of subdocuments is associated with.
boolean	isEmpty() Returns true if there are no subdocuments in this collection.
int	size() Returns the number of subdocuments in this collection.
Stream<Subdocument>	stream() Returns a sequential Stream with this subdocuments collection as its source.

Methods inherited from interface com.hpe.caf.worker.document.model.DocumentWorkerObject

getApplication

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

add

@Nonnull
Subdocument add(String reference)

Creates a new subdocument and adds it to the collection.

Parameters:

reference - the reference that the subdocument should initially be assigned

Returns:

the newly created subdocument

get

@Nonnull
Subdocument get(int index)

Retrieves the subdocument at the specified position.

Note that if a subdocument in the list is deleted that this will affect the positions of the subdocuments which follow it in the subdocument list.

Parameters:

index - index of the subdocument to return

Returns:

the subdocument at the specified position

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

getDocument

@Nonnull
Document getDocument()

Returns the document that this collection of subdocuments is associated with.

Returns:

the document that this collection of subdocuments is associated with

isEmpty

boolean isEmpty()

Returns true if there are no subdocuments in this collection.

Returns:

true if there are no subdocuments in this collection

size

int size()

Returns the number of subdocuments in this collection.

Returns:

the number of subdocuments in this collection

stream

@Nonnull
Stream<Subdocument> stream()

Returns a sequential Stream with this subdocuments collection as its source.

Returns:

a sequential Stream over the collection of subdocuments