Package com.typesafe.config
Interface ConfigIncluder
public interface ConfigIncluder
Implement this interface and provide an instance to
ConfigParseOptions.setIncluder()
to
customize handling of include
statements in config files. You may
also want to implement ConfigIncluderClasspath
,
ConfigIncluderFile
, and ConfigIncluderURL
, or not.-
Method Summary
Modifier and TypeMethodDescriptioninclude
(ConfigIncludeContext context, String what) Parses another item to be included.withFallback
(ConfigIncluder fallback) Returns a new includer that falls back to the given includer.
-
Method Details
-
withFallback
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.- Parameters:
fallback
- the previous includer for chaining- Returns:
- a new includer
-
include
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 implementingConfigIncluder
must also implementConfigIncluderClasspath
,ConfigIncluderFile
, orConfigIncluderURL
as needed, or a default includer will be used.- Parameters:
context
- some info about the include contextwhat
- the include statement's argument- Returns:
- a non-null ConfigObject
-