grizzled.file

Includer

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: 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. val DefaultIncludeRegex: Regex

    The default regular expression for matching include directives.

  7. val DefaultMaxNesting: Int

    The default maximum nesting level for includes.

  8. def apply(pathOrURI: String): Includer

    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

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

    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.

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

    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

  11. def apply(source: Source): Includer

    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

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

    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.

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

    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

  14. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  15. def clone(): AnyRef

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

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

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

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

    Definition Classes
    AnyRef
  25. def preprocess(pathOrURI: String, tempPrefix: String, tempSuffix: String): String

    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

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

    Definition Classes
    AnyRef
  27. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped