com.hpe.caf.worker.document.views

Class ReadOnlyDocument

java.lang.Object

com.hpe.caf.worker.document.views.ReadOnlyDocument

public final class ReadOnlyDocument
extends Object

Provides a read-only, non-null, view of an underlying document object. This can be used when the underlying document object must not be changed. It can be passed around in lieu of the document object to allow it to be read without the danger of it being manipulated. Additionally it also makes the underlying document easier to read, as it translates nulls into empty sets or lists where possible.

Method Summary

Modifier and Type	Method and Description
static ReadOnlyDocument	create(DocumentWorkerDocument document) Constructs a ReadOnlyDocument object which provides read access to the specified document.
static ReadOnlyDocument	create(Map<String,List<DocumentWorkerFieldValue>> fields) Constructs a ReadOnlyDocument object which provides read access to the specified fields.
static ReadOnlyDocument	create(MutableDocument document) Constructs a ReadOnlyDocument object which provides read access to the specified document.
static ReadOnlyDocument	create(String reference) Constructs a ReadOnlyDocument object for document which just has a reference but does not have any fields or subdocuments.
List<ReadOnlyFailure>	getFailures()
Map<String,List<ReadOnlyFieldValue>>	getFields()
String	getReference()
List<ReadOnlyDocument>	getSubdocuments()

Methods inherited from class java.lang.Object

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

Method Detail

create

@Nonnull
public static ReadOnlyDocument create(Map<String,List<DocumentWorkerFieldValue>> fields)

Constructs a ReadOnlyDocument object which provides read access to the specified fields.

Note: The specified fields must not be changed after this object is constructed.

Parameters:

fields - the map of fields to wrap

Returns:

the new read-only document object

create

@Nonnull
public static ReadOnlyDocument create(DocumentWorkerDocument document)

Constructs a ReadOnlyDocument object which provides read access to the specified document.

Note: The specified document must not be changed after this object is constructed. If this constraint is violated then there will be undefined results. What is presented may contain elements of both the original and current document.

Parameters:

document - the document to wrap

Returns:

the new read-only document object

create

@Nonnull
public static ReadOnlyDocument create(MutableDocument document)

Constructs a ReadOnlyDocument object which provides read access to the specified document.

Note: The specified document must not be changed after this object is constructed. If this constraint is violated then there will be undefined results. What is presented may contain elements of both the original and current document.

Parameters:

document - the document to wrap

Returns:

the new read-only document object

create

@Nonnull
public static ReadOnlyDocument create(String reference)

Constructs a ReadOnlyDocument object for document which just has a reference but does not have any fields or subdocuments.

This could be useful to represent the initial state of a newly created document.

Parameters:

reference - the reference that the document should have

Returns:

the new read-only document object

getReference

public String getReference()

getFields

@Nonnull
public Map<String,List<ReadOnlyFieldValue>> getFields()

getFailures

@Nonnull
public List<ReadOnlyFailure> getFailures()

getSubdocuments

@Nonnull
public List<ReadOnlyDocument> getSubdocuments()