Object/Class

grizzled.file

Includer

Related Docs: class Includer | package file

Permalink

object Includer

Companion object for the Includer class. Also contains some utility methods, such as the preprocess() method.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Includer
  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: 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. val DefaultIncludeRegex: Regex

    Permalink

    The default regular expression for matching include directives.

  5. val DefaultMaxNesting: Int

    Permalink

    The default maximum nesting level for includes.

  6. def apply(pathOrURI: String): Includer

    Permalink

    Allocate an includer, using the default values for the maxNesting and includeRegex parameters.

    Allocate an includer, using the default values for the maxNesting and includeRegex parameters.

    pathOrURI

    the path or URI string to read

  7. def apply(pathOrURI: String, includeRegex: Regex): Includer

    Permalink

    Allocate an includer, using the default value for the maxNesting parameter.

    Allocate an includer, using the default value for the maxNesting parameter.

    pathOrURI

    the path or URI string to read

    includeRegex

    the regular expression that defines an include directive. Must contain a group that surrounds the file or URL part.

  8. def apply(pathOrURI: String, includeRegex: Regex, maxNesting: Int): Includer

    Permalink

    Allocate an includer.

    Allocate an includer.

    pathOrURI

    the path or URI string to read

    includeRegex

    the regular expression that defines an include directive. Must contain a group that surrounds the file or URL part.

    maxNesting

    the maximum nesting level

  9. def apply(source: Source): Includer

    Permalink

    Allocate an includer, using the default values for the maxNesting and includeRegex parameters.

    Allocate an includer, using the default values for the maxNesting and includeRegex parameters.

    source

    the Source to read

  10. def apply(source: Source, includeRegex: Regex): Includer

    Permalink

    Allocate an includer, using the default value for the maxNesting parameter.

    Allocate an includer, using the default value for the maxNesting parameter.

    source

    the Source to read

    includeRegex

    the regular expression that defines an include directive. Must contain a group that surrounds the file or URL part.

  11. def apply(source: Source, includeRegex: Regex, maxNesting: Int): Includer

    Permalink

    Allocate an includer.

    Allocate an includer.

    source

    the Source to read

    includeRegex

    the regular expression that defines an include directive. Must contain a group that surrounds the file or URL part.

    maxNesting

    the maximum nesting level

  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def clone(): AnyRef

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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. def preprocess(pathOrURI: String, tempPrefix: String, tempSuffix: String): String

    Permalink

    Process all include directives in the specified file, returning a path to a temporary file that contains the results of the expansion.

    Process all include directives in the specified file, returning a path to a temporary file that contains the results of the expansion. The temporary file is automatically removed when the program exits, though the caller is free to remove it whenever it is no longer needed.

    pathOrURI

    the path or URI string to read

    tempPrefix

    temporary file prefix, with the same meaning as the temporary file prefix used by java.io.File.createTempFile()

    tempSuffix

    temporary file suffix, with the same meaning as the temporary file suffix used by java.io.File.createTempFile()

    returns

    the path to the temporary file

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

    Permalink
    Definition Classes
    AnyRef
  25. def toString(): String

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped