org.modeshape.schematic

Interface SchematicEntry

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface SchematicEntry

A wrapper over a conventional Document which exposes a predefined structure of documents usually stored inside a SchematicDb.

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SchematicEntry.FieldName

Method Summary

Modifier and Type	Method and Description
default Document	content() Return this document's content.
static Document	content(Document entryDocument) Returns the value of the CONTENT document from a given entry document.
static SchematicEntry	create(String id) Creates a new empty entry with the given id.
static SchematicEntry	create(String id, Document content) Creates a new entry with the given content.
default Document	getMetadata() Get the metadata associated with this document.
default String	id() Returns this document's id.
static String	id(Document entryDocument) Returns the value of the ID from a given entry document.
Document	source() Returns the original document which is wrapped by this entry.

Method Detail

source

Document source()

Returns the original document which is wrapped by this entry.

Returns:

a Document instance, never null

getMetadata

default Document getMetadata()

Get the metadata associated with this document.

Returns:

the metadata document or null if there is no metadata document

content

default Document content()

Return this document's content. The result will either be a Document or null.

Returns:

the content, or null if there is no content

id

default String id()

Returns this document's id.

Returns:

the ID, or null if no ID field is present

Throws:

NullPointerException - if this document does not have a metadata section

create

static SchematicEntry create(String id)

Creates a new empty entry with the given id.

Parameters:

id - the id of the document, may not be null.

Returns:

a new SchematicEntry, never null

create

static SchematicEntry create(String id,
                             Document content)

Creates a new entry with the given content.

Parameters:

id - the id of the document, may not be null.

content - the id of the document, may not be null.

Returns:

a new SchematicEntry, never null

id

static String id(Document entryDocument)

Returns the value of the ID from a given entry document.

Parameters:

entryDocument - a Document instance representing a schematic entry.

Returns:

a String or null if there is no SchematicEntry.FieldName.METADATA document or if that document doesn't have an id.

content

static Document content(Document entryDocument)

Returns the value of the CONTENT document from a given entry document.

Parameters:

entryDocument - a Document instance representing a schematic entry.

Returns:

a Document or null if there is no SchematicEntry.FieldName.CONTENT document.