Value Members

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

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

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

   Definition Classes

   AnyRef → Any

4.  val DefaultIncludeRegex: Regex

   The default regular expression for matching include directives.

5.  val DefaultMaxNesting: Int

   The default maximum nesting level for includes.

6.  def apply(pathOrURI: String, includeRegex: Regex, maxNesting: Int): Try[Includer]

   Create an includer.

   Create 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

   returns

   Success(Includer) or Failure(Exception)

7.  def apply(pathOrURI: String): Try[Includer]

   Create an includer from a path, using the default values for the maxNesting and includeRegex parameters.

   Create an includer from a path, using the default values for the maxNesting and includeRegex parameters.

   pathOrURI

   the path or URI string to read

8.  def apply(path: String, maxNesting: Int): Try[Includer]

   Create an includer from a path, using the default value for the includeRegex parameter.

   Create an includer from a path, using the default value for the includeRegex parameter.

   path

   the path or URI string to read

   maxNesting

   the maximum nesting level

   returns

   Success(Includer) or Failure(Exception)

9.  def apply(pathOrURI: String, includeRegex: Regex): Try[Includer]

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

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

   returns

   Success(Includer) or Failure(Exception)

10.  def apply(source: Source): Try[Includer]

    Create an includer from a scala.io.Source, using the default values for the maxNesting and includeRegex parameters.

    Create an includer from a scala.io.Source, using the default values for the maxNesting and includeRegex parameters.

    WARNING: When you read from a Source, Includer has no reliable way to determine the base URI or file, so all include references must be absolute. Relative includes may be supported, depending on what the Source is (file, URL, etc.), but you shouldn't count on it.

    source

    the Source to read

    returns

    Success(Includer) or Failure(Exception)

11.  def apply(source: Source, includeRegex: Regex): Try[Includer]

    Create an includer from a scala.io.Source, using the default value for the maxNesting parameter.

    Create an includer from a scala.io.Source, using the default value for the maxNesting parameter.

    WARNING: When you read from a Source, Includer has no reliable way to determine the base URI or file, so all include references must be absolute. Relative includes may be supported, depending on what the Source is (file, URL, etc.), but you shouldn't count on it.

    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.

    returns

    Success(Includer) or Failure(Exception)

12.  def apply(source: Source, maxNesting: Int): Try[Includer]

    Create an includer from a scala.io.Source, using the default value for the includeRegex parameter.

    Create an includer from a scala.io.Source, using the default value for the includeRegex parameter.

    WARNING: When you read from a Source, Includer has no reliable way to determine the base URI or file, so all include references must be absolute. Relative includes may be supported, depending on what the Source is (file, URL, etc.), but you shouldn't count on it.

    source

    the Source to read

    maxNesting

    the maximum nesting level

    returns

    Success(Includer) or Failure(Exception)

13.  def apply(source: Source, includeRegex: Regex, maxNesting: Int): Try[Includer]

    Create an includer from a scala.io.Source.

    Create an includer from a scala.io.Source.

    WARNING: When you read from a Source, Includer has no reliable way to determine the base URI or file, so all include references must be absolute. Relative includes may be supported, depending on what the Source is (file, URL, etc.), but you shouldn't count on it.

    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

    returns

    Success(Includer) or Failure(Exception)

14.  def apply(file: File, includeRegex: Regex, maxNesting: Int): Try[Includer]

    Create an includer from a java.io.File.

    Create an includer from a java.io.File.

    file

    the File from which 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

    returns

    Success(Includer) or Failure(Exception)

15.  def apply(file: File, maxNesting: Int): Try[Includer]

    Create an includer from a java.io.File, using the default value for the includeRegex parameter.

    Create an includer from a java.io.File, using the default value for the includeRegex parameter.

    file

    the File to read

    maxNesting

    the maximum nesting level

    returns

    Success(Includer) or Failure(Exception)

16.  def apply(file: File, includeRegex: Regex): Try[Includer]

    Create an includer from a java.io.File, using the default value for the maxNesting parameter.

    Create an includer from a java.io.File, using the default value for the maxNesting parameter.

    file

    the File from which to read

    includeRegex

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

    returns

    Success(Includer) or Failure(Exception)

17.  def apply(file: File): Try[Includer]

    Create an includer from a java.io.File, using the default values for the maxNesting and includeRegex parameters.

    Create an includer from a java.io.File, using the default values for the maxNesting and includeRegex parameters.

    file

    the File from which to read

    returns

    Success(Includer) or Failure(Exception)

18.  final def asInstanceOf[T0]: T0

    Definition Classes

    Any

19.  def clone(): AnyRef

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )

20.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

21.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

22.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

23.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

24.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

25.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

26.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

27.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

28.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

29.  def preprocess(pathOrURI: String, tempPrefix: String, tempSuffix: String): Try[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

    Success(path) where path is the path to the temporary file, or Failure(exception)

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

    Definition Classes

    AnyRef

31.  def toString(): String

    Definition Classes

    AnyRef → Any

32.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

34.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )