Packages

c

laika.ast

DocumentTreeBuilder

class DocumentTreeBuilder extends AnyRef

API for a safe and concise way of constructing a DocumentTree.

The hierarchy of the tree will be constructed based on the provided Path instances while also ensuring that document configuration is wired up correctly (inheriting the configuration from directories).

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentTreeBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addConfig(config: Config): DocumentTreeBuilder

    Add the specified tree configuration to the builder.

    Add the specified tree configuration to the builder. The path it will be assigned to will be taken from the origin property of the Config instance. Existing instances with identical paths will be overridden.

    For assigning a configuration to a specific document and not an entire tree or subtree, set the config property of a Document instance directly before adding it to the builder.

  5. def addDocument(doc: Document): DocumentTreeBuilder

    Add the specified document to the builder.

    Add the specified document to the builder. Existing instances with identical paths will be overridden.

  6. def addDocuments(docs: List[Document]): DocumentTreeBuilder

    Add the specified documents to the builder.

    Add the specified documents to the builder. Existing instances with identical paths will be overridden.

  7. def addTemplate(doc: TemplateDocument): DocumentTreeBuilder

    Add the specified template to the builder.

    Add the specified template to the builder. Existing instances with identical paths will be overridden.

  8. def addTemplates(docs: List[TemplateDocument]): DocumentTreeBuilder

    Add the specified templates to the builder.

    Add the specified templates to the builder. Existing instances with identical paths will be overridden.

  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def build(baseConfig: Config): DocumentTree

    Builds a DocumentTree from the provided instances, using the specified Config instance as a base for the configuration of all trees and documents.

    Builds a DocumentTree from the provided instances, using the specified Config instance as a base for the configuration of all trees and documents. Also wires configuration of documents to that of parent trees for proper inheritance.

  11. def build: DocumentTree

    Builds a DocumentTree from the provided instances and wires the configuration of documents to that of parent trees for proper inheritance.

  12. def buildRoot(baseConfig: Config): DocumentTreeRoot

    Builds a DocumentTreeRoot from the provided instances, using the specified Config instance as a base for the configuration of all trees and documents.

    Builds a DocumentTreeRoot from the provided instances, using the specified Config instance as a base for the configuration of all trees and documents. Also wires configuration of documents to that of parent trees for proper inheritance.

  13. def buildRoot: DocumentTreeRoot

    Builds a DocumentTreeRoot from the provided instances and wires the configuration of documents to that of parent trees for proper inheritance.

  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped