com.hpe.caf.worker.document.impl

Class SubdocumentsImpl

java.lang.Object

com.hpe.caf.worker.document.impl.DocumentWorkerObjectImpl

com.hpe.caf.worker.document.impl.SubdocumentsImpl

All Implemented Interfaces:

DocumentWorkerObject, Subdocuments, Iterable<Subdocument>

public final class SubdocumentsImpl
extends DocumentWorkerObjectImpl
implements Subdocuments

Field Summary

Fields inherited from class com.hpe.caf.worker.document.impl.DocumentWorkerObjectImpl

application

Constructor Summary

Constructors

Constructor and Description
SubdocumentsImpl(ApplicationImpl application, DocumentImpl document, List<ReadOnlyDocument> originalSubdocuments)

Method Summary

Modifier and Type	Method and Description
Subdocument	add(String reference)
Subdocument	get(int index)
DocumentImpl	getDocument()
boolean	hasChanges()
boolean	isEmpty()
Iterator<Subdocument>	iterator()
void	recordChanges(ChangesJournal journal)
void	reset()
int	size()
Stream<Subdocument>	stream()

Methods inherited from class com.hpe.caf.worker.document.impl.DocumentWorkerObjectImpl

getApplication

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getApplication

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SubdocumentsImpl

public SubdocumentsImpl(ApplicationImpl application,
                        DocumentImpl document,
                        List<ReadOnlyDocument> originalSubdocuments)

Method Detail

add

@Nonnull
public Subdocument add(String reference)

Specified by:

add in interface Subdocuments

get

@Nonnull
public Subdocument get(int index)

Note: Currently this collection does not store which subdocuments are deleted. For this reason the implementation of this method must work through each of the subdocuments and check their status rather than being able to directly go to the correct subdocument. It's easy to imagine that this would not be appropriate if there were a large number of subdocuments. If that were ever to be the case then we would have to implement a callback from the SubdocumentImpl class to create visibility here with regard to which documents have been deleted.

Specified by:

get in interface Subdocuments

Parameters:

index - index of the subdocument to return

Returns:

the subdocument at the specified position

getDocument

@Nonnull
public DocumentImpl getDocument()

Specified by:

getDocument in interface Subdocuments

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Subdocuments

iterator

@Nonnull
public Iterator<Subdocument> iterator()

Specified by:

iterator in interface Iterable<Subdocument>

size

public int size()

Specified by:

size in interface Subdocuments

stream

@Nonnull
public Stream<Subdocument> stream()

Specified by:

stream in interface Subdocuments

hasChanges

public boolean hasChanges()

reset

public void reset()

recordChanges

public void recordChanges(ChangesJournal journal)