Trait

laika.io

InputTreeOps

Related Doc: package io

Permalink

trait InputTreeOps extends AnyRef

API for producing a result from processing various types of input trees.

This is essentially a collection of shortcuts that allow any class merging in this trait to define all input related operations in terms of the only abstract method fromInputTree. Calling fromDirectory("src") for example is only a convenient shortcut for calling fromInputTree(InputTree.fromDirectory("src").

Linear Supertypes
AnyRef, Any
Known Subclasses
Parse, StaticDocuments, Transform, TransformGatheredOutput, TransformMappedOutput
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InputTreeOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type InputTreeResult

    Permalink

    The type of the result returned by all operations of this trait.

Abstract Value Members

  1. abstract def config: OperationConfig

    Permalink

    The configuration to use for all input operations.

  2. abstract def fromInputTree(inputTree: InputTree): InputTreeResult

    Permalink

    Returns the result obtained by parsing files from the specified input tree.

    Returns the result obtained by parsing files from the specified input tree.

    inputTree

    the input tree to process

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. def fromDefaultDirectory(exclude: FileFilter = hiddenFileFilter)(implicit codec: Codec): InputTreeResult

    Permalink

    Returns the result obtained by parsing files from the current working directory.

    Returns the result obtained by parsing files from the current working directory.

    exclude

    the files to exclude from processing

    codec

    the character encoding of the files, if not specified the platform default will be used.

  10. def fromDirectories(roots: Seq[File], exclude: FileFilter)(implicit codec: Codec): InputTreeResult

    Permalink

    Returns the result obtained by parsing files from the specified directories and its subdirectories, merging them into a tree with a single root.

    Returns the result obtained by parsing files from the specified directories and its subdirectories, merging them into a tree with a single root.

    roots

    the root directories to traverse

    exclude

    the files to exclude from processing

    codec

    the character encoding of the files, if not specified the platform default will be used.

  11. def fromDirectories(roots: Seq[File])(implicit codec: Codec): InputTreeResult

    Permalink

    Returns the result obtained by parsing files from the specified directories and its subdirectories, merging them into a tree with a single root.

    Returns the result obtained by parsing files from the specified directories and its subdirectories, merging them into a tree with a single root.

    roots

    the root directories to traverse

    codec

    the character encoding of the files, if not specified the platform default will be used.

  12. def fromDirectory(dir: File, exclude: FileFilter)(implicit codec: Codec): InputTreeResult

    Permalink

    Returns the result obtained by parsing files from the specified directory and its subdirectories.

    Returns the result obtained by parsing files from the specified directory and its subdirectories.

    dir

    the root directory to traverse

    exclude

    the files to exclude from processing

    codec

    the character encoding of the files, if not specified the platform default will be used.

  13. def fromDirectory(dir: File)(implicit codec: Codec): InputTreeResult

    Permalink

    Returns the result obtained by parsing files from the specified directory and its subdirectories.

    Returns the result obtained by parsing files from the specified directory and its subdirectories.

    dir

    the root directory to traverse

    codec

    the character encoding of the files, if not specified the platform default will be used.

  14. def fromDirectory(name: String, exclude: FileFilter)(implicit codec: Codec): InputTreeResult

    Permalink

    Returns the result obtained by parsing files from the specified directory and its subdirectories.

    Returns the result obtained by parsing files from the specified directory and its subdirectories.

    name

    the name of the directory to traverse

    exclude

    the files to exclude from processing

    codec

    the character encoding of the files, if not specified the platform default will be used.

  15. def fromDirectory(name: String)(implicit codec: Codec): InputTreeResult

    Permalink

    Returns the result obtained by parsing files from the specified directory and its subdirectories.

    Returns the result obtained by parsing files from the specified directory and its subdirectories.

    name

    the name of the directory to traverse

    codec

    the character encoding of the files, if not specified the platform default will be used.

  16. def fromInputTree(builder: InputTreeBuilder): InputTreeResult

    Permalink

    Returns the result obtained by parsing files from the specified input tree builder.

    Returns the result obtained by parsing files from the specified input tree builder.

    builder

    a builder for the input tree to process

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped