Uses of Interface
com.speedment.config.Document

Packages that use Document

Package	Description
com.speedment.code	Fundamental Code Generation componenets is located in this package.
com.speedment.config	The configuration system is located in this package.
com.speedment.config.db	Interfaces for exposing a typed database-specific view of a Document tree is located in this package.
com.speedment.config.db.mutator	Implementations of the DocumentMutator interface that help modify a Document in a type-safe manner are located in this package.
com.speedment.config.db.trait	Common traits used in the typed configuration documents are located in this package.

Uses of Document in com.speedment.code

Classes in com.speedment.code with type parameters of type Document

Modifier and Type	Interface and Description
interface	Translator<DOC extends Document & HasMainInterface,T> Something that can translate a Document into something else.
class	TranslatorSupport<DOC extends Document & HasName & HasMainInterface> A support class for the Translator interface that holds various naming methods used in the translator implementations.

Methods in com.speedment.code with type parameters of type Document

Modifier and Type	Method and Description
default <P extends Document,DOC extends Document> Translator.Builder<T>	Translator.Builder.forEvery(String key, BiFunction<P,Map<String,Object>,DOC> constructor, BiConsumer<T,DOC> consumer) Executes the specified code for every document of the specified type that is found during this build.
default <P extends Document,DOC extends Document> Translator.Builder<T>	Translator.Builder.forEvery(String key, BiFunction<P,Map<String,Object>,DOC> constructor, BiConsumer<T,DOC> consumer) Executes the specified code for every document of the specified type that is found during this build.
<P extends Document,DOC extends Document> Translator.Builder<T>	Translator.Builder.forEvery(Translator.Phase phase, String key, BiFunction<P,Map<String,Object>,DOC> constructor, BiConsumer<T,DOC> consumer) Executes the specified code for every document of the specified type that is found during this build.
<P extends Document,DOC extends Document> Translator.Builder<T>	Translator.Builder.forEvery(Translator.Phase phase, String key, BiFunction<P,Map<String,Object>,DOC> constructor, BiConsumer<T,DOC> consumer) Executes the specified code for every document of the specified type that is found during this build.
default <E extends Document> Optional<E>	Translator.getDocument(Class<E> clazz) Returns this node or one of the ancestor nodes if it matches the specified Class.

Uses of Document in com.speedment.config

Methods in com.speedment.config with type parameters of type Document

Modifier and Type	Method and Description
default <P extends Document,T extends Document> Stream<T>	Document.children(String key, BiFunction<P,Map<String,Object>,T> constructor) Returns the children on the specified key, instantiated using the specified constructor.
default <P extends Document,T extends Document> Stream<T>	Document.children(String key, BiFunction<P,Map<String,Object>,T> constructor) Returns the children on the specified key, instantiated using the specified constructor.

Methods in com.speedment.config that return types with arguments of type Document

Modifier and Type	Method and Description
default Stream<Document>	Document.ancestors() Returns a Stream of every ancestor to this Document, beginning with the first ancestor (the root) and ending with the parent of this Document.
Stream<? extends Document>	Document.children() Returns a Stream of child documents, instantiated using the default document implementation.
Optional<? extends Document>	Document.getParent() Returns the parent of this Document or Optional.empty() if the Document does not have a parent.

Uses of Document in com.speedment.config.db

Subinterfaces of Document in com.speedment.config.db

Modifier and Type	Interface and Description
interface	Column A typed Document that represents a column in the database.
interface	Dbms A typed Document that represents a dbms instance in the database.
interface	ForeignKey A typed Document that represents a foreign key instance in the database.
interface	ForeignKeyColumn A typed Document that represents the column referenced by a foreign key instance in the database.
interface	Index A typed Document that represents an index instance in the database.
interface	IndexColumn A typed Document that represents the column referenced by an index key instance in the database.
interface	PrimaryKeyColumn A typed Document that represents the primary key column instance in the database.
interface	Project A typed Document that represents a database project.
interface	Schema A typed Document that represents a schema instance in the database.
interface	Table A typed Document that represents a table instance in the database.

Uses of Document in com.speedment.config.db.mutator

Classes in com.speedment.config.db.mutator with type parameters of type Document

Modifier and Type	Interface and Description
interface	DocumentMutator<DOC extends Document>

Uses of Document in com.speedment.config.db.trait

Classes in com.speedment.config.db.trait with type parameters of type Document

Modifier and Type	Interface and Description
interface	HasParent<PARENT extends Document> Trait for Document implementations that is not the root.

Subinterfaces of Document in com.speedment.config.db.trait

Modifier and Type	Interface and Description
interface	HasAlias Trait for Document implementations that implement the HasAlias.getAlias() method.
interface	HasChildren Trait for Document implementations that has named children and therefore implements the defaultNameFor(Document) method.
interface	HasColumn Trait for Document implementations that reference another Column document and therefore has a HasColumn.findColumn() method.
interface	HasEnabled Trait for Document implementations that implement the HasEnabled.isEnabled() method.
interface	HasMainInterface A trait for documents that implement the HasMainInterface.mainInterface() method.
interface	HasName Trait for Document implementations that implement the HasName.getName() method.
interface	HasNullable Trait for Document implementations that implement the HasNullable.isNullable() method.
interface	HasOrderType Trait for Document implementations that implement the HasOrderType.getOrderType() method.
interface	HasOrdinalPosition Trait for Document implementations that implement the HasOrdinalPosition.getOrdinalPosition() method.
interface	HasParent<PARENT extends Document> Trait for Document implementations that is not the root.

Methods in com.speedment.config.db.trait with type parameters of type Document

Modifier and Type	Method and Description
default <C extends Document & HasName & HasMainInterface> String	HasChildren.defaultNameFor(C childDocument) Generates a new default name for the specified child by appending an unique number to the HasMainInterface.mainInterface() of that document.

Methods in com.speedment.config.db.trait that return types with arguments of type Document

Modifier and Type	Method and Description
Class<? extends Document>	HasMainInterface.mainInterface() Returns the Class of the interface of this node.

Methods in com.speedment.config.db.trait with parameters of type Document

Modifier and Type	Method and Description
static HasOrdinalPosition	HasOrdinalPosition.of(Document document) Returns a wrapper of the specified document that implements the HasOrdinalPosition trait.
static HasOrderType	HasOrderType.of(Document document) Returns a wrapper of the specified document that implements the HasOrderType trait.
static HasNullable	HasNullable.of(Document document) Returns a wrapper of the specified document that implements the HasNullable trait.
static HasName	HasName.of(Document document) Returns a wrapper of the specified document that implements the HasName trait.
static HasEnabled	HasEnabled.of(Document document) Returns a wrapper of the specified document that implements the HasEnabled trait.
static HasColumn	HasColumn.of(Document document) Returns a wrapper of the specified document that implements the HasColumn trait.
static HasAlias	HasAlias.of(Document document) Returns a wrapper of the specified document that implements the HasAlias trait.
static boolean	HasEnabled.test(Document doc) Returns true if the specified Document should be considered enabled, else false.