laika.api.Transform

BatchConfigBuilder

class BatchConfigBuilder extends AnyRef

API for configuring a batch operation. Gives access to all relevant aspects of traversing, parsing and rendering a tree of inputs.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BatchConfigBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def build(parser: ParserFactory): BatchConfig

    Builds the final configuration for this input tree for the specified parser factory.

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  14. def inParallel: BatchConfigBuilder

    Instructs both the parser and renderer to process all inputs and outputs in parallel.

    Instructs both the parser and renderer to process all inputs and outputs in parallel. The recursive structure of document trees will be flattened before parsing and rendering and then get reassembled afterwards, therefore the parallel processing includes all subtrees of the document tree.

    The actual transformation is a three phase process, the first (parsing) and third (rendering) can run in parallel. The second phase in the middle cannot, as this is the document tree model rewrite step where things like cross references or table of contents get processed that need access to more than just the current document.

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  20. def toString(): String

    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. def withConfigFile(name: String): BatchConfigBuilder

    Specifies the name of a root configuration file that gets inherited by this tree and its subtrees.

    Specifies the name of a root configuration file that gets inherited by this tree and its subtrees. The syntax of the input is expected to be of a format compatible with the Typesafe Config library.

  25. def withConfigFile(file: File): BatchConfigBuilder

    Specifies a root configuration file that gets inherited by this tree and its subtrees.

    Specifies a root configuration file that gets inherited by this tree and its subtrees. The syntax of the input is expected to be of a format compatible with the Typesafe Config library.

  26. def withConfigString(source: String): BatchConfigBuilder

    Specifies a root configuration source that gets inherited by this tree and its subtrees.

    Specifies a root configuration source that gets inherited by this tree and its subtrees. The syntax of the input is expected to be of a format compatible with the Typesafe Config library.

  27. def withDocTypeMatcher(matcher: (Path) ⇒ DocumentType): BatchConfigBuilder

    Specifies the function to use for determining the document type of the input based on its path.

  28. def withTemplates(parser: ParseTemplate): BatchConfigBuilder

    Specifies the template engine to use for parsing all template inputs found in the tree.

Inherited from AnyRef

Inherited from Any

Ungrouped