- Companion
- object
Value members
Concrete methods
Appends a [[ConfigIncluder]] which customizes how
includes are handled. To append, the library calls
[[ConfigIncluder#withFallback]] on the existing includer.
Appends a [[ConfigIncluder]] which customizes how
includes are handled. To append, the library calls
[[ConfigIncluder#withFallback]] on the existing includer.
- Value Params
- includer
the includer to append (may not be null)
- Returns
new version of the parse options with different includer
Gets the current "allow missing" flag.
Gets the current "allow missing" flag.
- Returns
whether we allow missing files
Get the class loader; never returns null, if the class loader was
unset, returns
Thread.currentThread().getContextClassLoader().
Get the class loader; never returns null, if the class loader was
unset, returns
Thread.currentThread().getContextClassLoader().
- Returns
class loader to use
Gets the current includer (will be null for the default includer).
Gets the current includer (will be null for the default includer).
- Returns
current includer or null
Gets the current origin description, which may be null for "automatic".
Gets the current origin description, which may be null for "automatic".
- Returns
the current origin description or null
Gets the current syntax option, which may be null for "any".
Gets the current syntax option, which may be null for "any".
- Returns
the current syntax or null
Prepends a [[ConfigIncluder]] which customizes how
includes are handled. To prepend your includer, the
library calls [[ConfigIncluder#withFallback]] on your
includer to append the existing includer to it.
Prepends a [[ConfigIncluder]] which customizes how
includes are handled. To prepend your includer, the
library calls [[ConfigIncluder#withFallback]] on your
includer to append the existing includer to it.
- Value Params
- includer
the includer to prepend (may not be null)
- Returns
new version of the parse options with different includer
Set to false to throw an exception if the item being parsed (for example a file) is missing. Set to true to just return an empty document in that case. Note that this setting applies on only to fetching the root document, it has no effect on any nested includes.
Set to false to throw an exception if the item being parsed (for example a file) is missing. Set to true to just return an empty document in that case. Note that this setting applies on only to fetching the root document, it has no effect on any nested includes.
- Value Params
- allowMissing
true to silently ignore missing item
- Returns
options with the "allow missing" flag set
Set the class loader. If set to null,
Thread.currentThread().getContextClassLoader() will be used.
Set the class loader. If set to null,
Thread.currentThread().getContextClassLoader() will be used.
- Value Params
- loader
a class loader or
nullto use thread context class loader
- Returns
options with the class loader set
Set a [[ConfigIncluder]] which customizes how includes are handled.
null means to use the default includer.
Set a [[ConfigIncluder]] which customizes how includes are handled.
null means to use the default includer.
- Value Params
- includer
the includer to use or null for default
- Returns
new version of the parse options with different includer
Set a description for the thing being parsed. In most cases this will be
set up for you to something like the filename, but if you provide just an
input stream you might want to improve on it. Set to null to allow the
library to come up with something automatically. This description is the
basis for the [[ConfigOrigin]] of the parsed values.
Set a description for the thing being parsed. In most cases this will be
set up for you to something like the filename, but if you provide just an
input stream you might want to improve on it. Set to null to allow the
library to come up with something automatically. This description is the
basis for the [[ConfigOrigin]] of the parsed values.
- Value Params
- originDescription
description to put in the
[[ConfigOrigin]]
- Returns
options with the origin description set
Set the file format. If set to null, try to guess from any available
filename extension; if guessing fails, assume [[ConfigSyntax#CONF]].
Set the file format. If set to null, try to guess from any available
filename extension; if guessing fails, assume [[ConfigSyntax#CONF]].
- Value Params
- syntax
a syntax or
nullfor best guess
- Returns
options with the syntax set