The default regular expression for matching include directives.
The default maximum nesting level for includes.
Create an includer.
Create an includer.
the path or URI string to read
the regular expression that defines an include directive. Must contain a group that surrounds the file or URL part.
the maximum nesting level
Success(Includer)
or Failure(Exception)
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.
the path or URI string to read
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.
the path or URI string to read
the maximum nesting level
Success(Includer)
or Failure(Exception)
Create an includer, using the default value for the
maxNesting
parameter.
Create an includer, using the default value for the
maxNesting
parameter.
the path or URI string to read
the regular expression that defines an include directive. Must contain a group that surrounds the file or URL part.
Success(Includer)
or Failure(Exception)
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.
the Source
to read
Success(Includer)
or Failure(Exception)
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.
the Source
to read
the regular expression that defines an include directive. Must contain a group that surrounds the file or URL part.
Success(Includer)
or Failure(Exception)
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.
the Source
to read
the maximum nesting level
Success(Includer)
or Failure(Exception)
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.
the Source
to read
the regular expression that defines an include directive. Must contain a group that surrounds the file or URL part.
the maximum nesting level
Success(Includer)
or Failure(Exception)
Create an includer from a java.io.File
.
Create an includer from a java.io.File
.
the File
from which to read
the regular expression that defines an include directive. Must contain a group that surrounds the file or URL part.
the maximum nesting level
Success(Includer)
or Failure(Exception)
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.
the File
to read
the maximum nesting level
Success(Includer)
or Failure(Exception)
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.
the File
from which to read
the regular expression that defines an include directive. Must contain a group that surrounds the file or URL part.
Success(Includer)
or Failure(Exception)
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.
the File
from which to read
Success(Includer)
or Failure(Exception)
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.
the path or URI string to read
temporary file prefix, with the same meaning as the
temporary file prefix used by
java.io.File.createTempFile()
temporary file suffix, with the same meaning as the
temporary file suffix used by
java.io.File.createTempFile()
Success(path)
where path
is the path to the temporary file,
or Failure(exception)
Companion object for the
Includer
class. Also contains some utility methods, such as thepreprocess()
method.