com.speedment.runtime.config.trait

Interface HasParent<PARENT extends Document>

Type Parameters:

PARENT - the type of the parent document

All Superinterfaces:

Document

All Known Subinterfaces:

Column, Dbms, ForeignKey, ForeignKeyColumn, Index, IndexColumn, PrimaryKeyColumn, Schema, Table

public interface HasParent<PARENT extends Document>
extends Document

Trait for Document implementations that is not the root. More concretely this means that they implement the getParent() method.

Version:

2.3.0

Author:

Emil Forslund

Method Summary

Modifier and Type	Method and Description
Optional<PARENT>	getParent() Returns the parent of this document.
default PARENT	getParentOrThrow() Returns the parent of this document or throws an exception if this was the root.

Methods inherited from interface com.speedment.runtime.config.Document

ancestors, children, children, get, getAsBoolean, getAsDouble, getAsInt, getAsLong, getAsString, getData, put

Method Detail

getParent

Optional<PARENT> getParent()

Returns the parent of this document. That is the document that is located exactly one step above this document in the tree. If this is a root node, an empty Optional is returned.

Specified by:

getParent in interface Document

Returns:

the parent or empty if this is the root

See Also:

getParentOrThrow()

getParentOrThrow

default PARENT getParentOrThrow()
                         throws IllegalStateException

Returns the parent of this document or throws an exception if this was the root. This method can be used if you know beforehand that this document is never the root.

Returns:

the parent document

Throws:

IllegalStateException - if this was the root

See Also:

getParent()