Object/Class

laika.bundle

StaticDocuments

Related Docs: class StaticDocuments | package bundle

Permalink

object StaticDocuments extends InputTreeOps with Serializable

API for defining a collection of static documents based on one or more directories.

Like with all Laika IO, these may be actual file system directories or virtual in-memory trees of input documents.

Linear Supertypes
Serializable, Serializable, InputTreeOps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StaticDocuments
  2. Serializable
  3. Serializable
  4. InputTreeOps
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type InputTreeResult = StaticDocuments

    Permalink

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

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

    Definition Classes
    StaticDocuments → InputTreeOps

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. def config: OperationConfig

    Permalink

    The configuration to use for all input operations.

    The configuration to use for all input operations.

    Definition Classes
    StaticDocuments → InputTreeOps

  7. val empty: StaticDocuments

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

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

  11. 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.

    Definition Classes
    InputTreeOps

  12. 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.

    Definition Classes
    InputTreeOps

  13. 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.

    Definition Classes
    InputTreeOps

  14. 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.

    Definition Classes
    InputTreeOps

  15. 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.

    Definition Classes
    InputTreeOps

  16. 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.

    Definition Classes
    InputTreeOps

  17. 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.

    Definition Classes
    InputTreeOps

  18. def fromInputTree(inputTree: InputTree): StaticDocuments

    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

    Definition Classes
    StaticDocuments → InputTreeOps

  19. 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

    Definition Classes
    InputTreeOps

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

    Permalink
    Definition Classes
    AnyRef → Any

  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  28. final def wait(): Unit

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

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

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from InputTreeOps

Inherited from AnyRef

Inherited from Any

Ungrouped