FullIncluder
Attributes
- Graph
-
- Supertypes
-
trait ConfigIncluderClasspathtrait ConfigIncluderURLtrait ConfigIncluderFiletrait ConfigIncluderclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class SimpleIncluder
Members list
Value members
Inherited methods
Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.
Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.
This method is used for a "heuristic" include statement that does not specify file, URL, or classpath resource. If the include statement does specify, then the same class implementing ConfigIncluder must also implement ConfigIncluderClasspath, ConfigIncluderFile, or ConfigIncluderURL as needed, or a default includer will be used.
Value parameters
- context
-
some info about the include context
- what
-
the include statement's argument
Attributes
- Returns
-
a non-null ConfigObject
- Inherited from:
- ConfigIncluder
Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.
Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.
Value parameters
- context
-
some info about the include context
- what
-
the include statement's argument
Attributes
- Returns
-
a non-null ConfigObject
- Inherited from:
- ConfigIncluderFile
Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.
Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.
Value parameters
- context
-
some info about the include context
- what
-
the include statement's argument
Attributes
- Returns
-
a non-null ConfigObject
- Inherited from:
- ConfigIncluderClasspath
Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.
Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.
Value parameters
- context
-
some info about the include context
- what
-
the include statement's argument
Attributes
- Returns
-
a non-null ConfigObject
- Inherited from:
- ConfigIncluderURL
Returns a new includer that falls back to the given includer. This is how you can obtain the default includer; it will be provided as a fallback. It's up to your includer to chain to it if you want to. You might want to merge any files found by the fallback includer with any objects you load yourself.
Returns a new includer that falls back to the given includer. This is how you can obtain the default includer; it will be provided as a fallback. It's up to your includer to chain to it if you want to. You might want to merge any files found by the fallback includer with any objects you load yourself.
It's important to handle the case where you already have the fallback with a "return this", i.e. this method should not create a new object if the fallback is the same one you already have. The same fallback may be added repeatedly.
Value parameters
- fallback
-
the previous includer for chaining
Attributes
- Returns
-
a new includer
- Inherited from:
- ConfigIncluder