Modifier and Type	Class and Description
pack-priv static interface	SimpleIncluder.NameSource
private static class	SimpleIncluder.Proxy
private static class	SimpleIncluder.RelativeNameSource

Modifier and Type	Field and Description
private ConfigIncluder	fallback

Access	Constructor and Description
pack-priv	SimpleIncluder(ConfigIncluder fallback)

Method Summary

Modifier and Type	Method and Description
pack-priv static ConfigParseOptions	clearForInclude(ConfigParseOptions options)
pack-priv static ConfigObject	fromBasename(SimpleIncluder.NameSource source, String name, ConfigParseOptions options)
public ConfigObject	include(final ConfigIncludeContext some info about the include context context, String the include statement's argument name) Implements com.typesafe.config.ConfigIncluder.include. Parses another item to be included.
public ConfigObject	includeFile(ConfigIncludeContext some info about the include context context, File the include statement's argument file) Implements com.typesafe.config.ConfigIncluderFile.includeFile. Parses another item to be included.
pack-priv static ConfigObject	includeFileWithoutFallback(final ConfigIncludeContext context, File file)
public ConfigObject	includeResources(ConfigIncludeContext some info about the include context context, String the include statement's argument resource) Implements com.typesafe.config.ConfigIncluderClasspath.includeResources. Parses another item to be included.
pack-priv static ConfigObject	includeResourceWithoutFallback(final ConfigIncludeContext context, String resource)
public ConfigObject	includeURL(ConfigIncludeContext some info about the include context context, URL the include statement's argument url) Implements com.typesafe.config.ConfigIncluderURL.includeURL. Parses another item to be included.
pack-priv static ConfigObject	includeURLWithoutFallback(final ConfigIncludeContext context, URL url)
pack-priv static ConfigObject	includeWithoutFallback(final ConfigIncludeContext context, String name)
pack-priv static FullIncluder	makeFull(ConfigIncluder includer)
public ConfigIncluder	withFallback(ConfigIncluder the previous includer for chaining fallback) Implements com.typesafe.config.ConfigIncluder.withFallback. Returns a new includer that falls back to the given includer.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

fallback	back to summary
private ConfigIncluder fallback

SimpleIncluder	back to summary
pack-priv SimpleIncluder(ConfigIncluder fallback)

Method Detail

clearForInclude	back to summary
pack-priv static ConfigParseOptions clearForInclude(ConfigParseOptions options)

fromBasename	back to summary
pack-priv static ConfigObject fromBasename(SimpleIncluder.NameSource source, String name, ConfigParseOptions options)

include back to summary

include	back to summary
public ConfigObject include(final ConfigIncludeContext context, String name) Implements com.typesafe.config.ConfigIncluder.include. Doc from com.typesafe.config.ConfigIncluder.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 implementing `ConfigIncluder` must also implement `ConfigIncluderClasspath`, `ConfigIncluderFile`, or `ConfigIncluderURL` as needed, or a default includer will be used. Parameters context:ConfigIncludeContext some info about the include context name:String the include statement's argument Returns:ConfigObject a non-null ConfigObject Annotations @Override

public ConfigObject include(final ConfigIncludeContext context, String name)

Implements com.typesafe.config.ConfigIncluder.include.

Doc from com.typesafe.config.ConfigIncluder.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 implementing ConfigIncluder must also implement ConfigIncluderClasspath, ConfigIncluderFile, or ConfigIncluderURL as needed, or a default includer will be used.

Parameters

context:ConfigIncludeContext: some info about the include context
name:String: the include statement's argument

Returns:ConfigObject

a non-null ConfigObject

Annotations

@Override

includeFile	back to summary
public ConfigObject includeFile(ConfigIncludeContext context, File file) Implements com.typesafe.config.ConfigIncluderFile.includeFile. Doc from com.typesafe.config.ConfigIncluderFile.includeFile. 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. Parameters context:ConfigIncludeContext some info about the include context file:File the include statement's argument Returns:ConfigObject a non-null ConfigObject Annotations @Override

includeFile

back to summary

public ConfigObject includeFile(ConfigIncludeContext context, File file)

Implements com.typesafe.config.ConfigIncluderFile.includeFile.

Doc from com.typesafe.config.ConfigIncluderFile.includeFile.

Parameters

context:ConfigIncludeContext: some info about the include context
file:File: the include statement's argument

Returns:ConfigObject

a non-null ConfigObject

Annotations

@Override

includeFileWithoutFallback	back to summary
pack-priv static ConfigObject includeFileWithoutFallback(final ConfigIncludeContext context, File file)

includeResources	back to summary
public ConfigObject includeResources(ConfigIncludeContext context, String resource) Implements com.typesafe.config.ConfigIncluderClasspath.includeResources. Doc from com.typesafe.config.ConfigIncluderClasspath.includeResources. 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. Parameters context:ConfigIncludeContext some info about the include context resource:String the include statement's argument Returns:ConfigObject a non-null ConfigObject Annotations @Override

includeResources

back to summary

public ConfigObject includeResources(ConfigIncludeContext context, String resource)

Implements com.typesafe.config.ConfigIncluderClasspath.includeResources.

Doc from com.typesafe.config.ConfigIncluderClasspath.includeResources.

Parameters

context:ConfigIncludeContext: some info about the include context
resource:String: the include statement's argument

Returns:ConfigObject

a non-null ConfigObject

Annotations

@Override

includeResourceWithoutFallback	back to summary
pack-priv static ConfigObject includeResourceWithoutFallback(final ConfigIncludeContext context, String resource)

includeURL	back to summary
public ConfigObject includeURL(ConfigIncludeContext context, URL url) Implements com.typesafe.config.ConfigIncluderURL.includeURL. Doc from com.typesafe.config.ConfigIncluderURL.includeURL. 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. Parameters context:ConfigIncludeContext some info about the include context url:URL the include statement's argument Returns:ConfigObject a non-null ConfigObject Annotations @Override

includeURL

back to summary

public ConfigObject includeURL(ConfigIncludeContext context, URL url)

Implements com.typesafe.config.ConfigIncluderURL.includeURL.

Doc from com.typesafe.config.ConfigIncluderURL.includeURL.

Parameters

context:ConfigIncludeContext: some info about the include context
url:URL: the include statement's argument

Returns:ConfigObject

a non-null ConfigObject

Annotations

@Override

includeURLWithoutFallback	back to summary
pack-priv static ConfigObject includeURLWithoutFallback(final ConfigIncludeContext context, URL url)

includeWithoutFallback	back to summary
pack-priv static ConfigObject includeWithoutFallback(final ConfigIncludeContext context, String name)

makeFull	back to summary
pack-priv static FullIncluder makeFull(ConfigIncluder includer)

withFallback	back to summary
public ConfigIncluder withFallback(ConfigIncluder fallback) Implements com.typesafe.config.ConfigIncluder.withFallback. Doc from com.typesafe.config.ConfigIncluder.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:ConfigIncluder the previous includer for chaining Returns:ConfigIncluder a new includer Annotations @Override

withFallback

back to summary

public ConfigIncluder withFallback(ConfigIncluder fallback)

Implements com.typesafe.config.ConfigIncluder.withFallback.

Doc from com.typesafe.config.ConfigIncluder.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:ConfigIncluder: the previous includer for chaining

Returns:ConfigIncluder

a new includer

Annotations

@Override

com.typesafe.config.impl back to summary

pack-priv Interface SimpleIncluder.NameSource

Known Direct Implementers: com.typesafe.config.impl.SimpleIncluder.RelativeNameSource, com.typesafe.config.impl.ConfigImpl.FileNameSource, com.typesafe.config.impl.ConfigImpl.ClasspathNameSource, com.typesafe.config.impl.ConfigImpl.ClasspathNameSourceWithClass

Method Summary

Modifier and Type	Method and Description
public ConfigParseable	nameToParseable(String name, ConfigParseOptions parseOptions)

Method Detail

nameToParseable	back to summary
public ConfigParseable nameToParseable(String name, ConfigParseOptions parseOptions)

com.typesafe.config.impl back to summary

private Class SimpleIncluder.Proxy

Class Inheritance

extends Object
implements FullIncluder

java.lang.Object
com.typesafe.config.impl.SimpleIncluder.Proxy

All Implemented Interfaces

com.typesafe.config.impl.FullIncluder, com.typesafe.config.ConfigIncluderClasspath, com.typesafe.config.ConfigIncluderURL, com.typesafe.config.ConfigIncluderFile, com.typesafe.config.ConfigIncluder

Field Summary

Modifier and Type	Field and Description
pack-priv final ConfigIncluder	delegate

Constructor Summary

Access	Constructor and Description
pack-priv	Proxy(ConfigIncluder delegate)

Method Summary

Modifier and Type	Method and Description
public ConfigObject	include(ConfigIncludeContext some info about the include context context, String the include statement's argument what) Implements com.typesafe.config.ConfigIncluder.include. Parses another item to be included.
public ConfigObject	includeFile(ConfigIncludeContext some info about the include context context, File the include statement's argument what) Implements com.typesafe.config.ConfigIncluderFile.includeFile. Parses another item to be included.
public ConfigObject	includeResources(ConfigIncludeContext some info about the include context context, String the include statement's argument what) Implements com.typesafe.config.ConfigIncluderClasspath.includeResources. Parses another item to be included.
public ConfigObject	includeURL(ConfigIncludeContext some info about the include context context, URL the include statement's argument what) Implements com.typesafe.config.ConfigIncluderURL.includeURL. Parses another item to be included.
public ConfigIncluder	withFallback(ConfigIncluder the previous includer for chaining fallback) Implements com.typesafe.config.ConfigIncluder.withFallback. Returns a new includer that falls back to the given includer.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegate	back to summary
pack-priv final ConfigIncluder delegate

Constructor Detail

Proxy	back to summary
pack-priv Proxy(ConfigIncluder delegate)

Method Detail

include back to summary

include	back to summary
public ConfigObject include(ConfigIncludeContext context, String what) Implements com.typesafe.config.ConfigIncluder.include. Doc from com.typesafe.config.ConfigIncluder.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 implementing `ConfigIncluder` must also implement `ConfigIncluderClasspath`, `ConfigIncluderFile`, or `ConfigIncluderURL` as needed, or a default includer will be used. Parameters context:ConfigIncludeContext some info about the include context what:String the include statement's argument Returns:ConfigObject a non-null ConfigObject Annotations @Override

public ConfigObject include(ConfigIncludeContext context, String what)

Implements com.typesafe.config.ConfigIncluder.include.

Doc from com.typesafe.config.ConfigIncluder.include.

Parameters

context:ConfigIncludeContext: some info about the include context
what:String: the include statement's argument

Returns:ConfigObject

a non-null ConfigObject

Annotations

@Override

includeFile	back to summary
public ConfigObject includeFile(ConfigIncludeContext context, File what) Implements com.typesafe.config.ConfigIncluderFile.includeFile. Doc from com.typesafe.config.ConfigIncluderFile.includeFile. 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. Parameters context:ConfigIncludeContext some info about the include context what:File the include statement's argument Returns:ConfigObject a non-null ConfigObject Annotations @Override

includeFile

back to summary

public ConfigObject includeFile(ConfigIncludeContext context, File what)

Implements com.typesafe.config.ConfigIncluderFile.includeFile.

Doc from com.typesafe.config.ConfigIncluderFile.includeFile.

Parameters

context:ConfigIncludeContext: some info about the include context
what:File: the include statement's argument

Returns:ConfigObject

a non-null ConfigObject

Annotations

@Override

includeResources	back to summary
public ConfigObject includeResources(ConfigIncludeContext context, String what) Implements com.typesafe.config.ConfigIncluderClasspath.includeResources. Doc from com.typesafe.config.ConfigIncluderClasspath.includeResources. 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. Parameters context:ConfigIncludeContext some info about the include context what:String the include statement's argument Returns:ConfigObject a non-null ConfigObject Annotations @Override

includeResources

back to summary

public ConfigObject includeResources(ConfigIncludeContext context, String what)

Implements com.typesafe.config.ConfigIncluderClasspath.includeResources.

Doc from com.typesafe.config.ConfigIncluderClasspath.includeResources.

Parameters

context:ConfigIncludeContext: some info about the include context
what:String: the include statement's argument

Returns:ConfigObject

a non-null ConfigObject

Annotations

@Override

includeURL	back to summary
public ConfigObject includeURL(ConfigIncludeContext context, URL what) Implements com.typesafe.config.ConfigIncluderURL.includeURL. Doc from com.typesafe.config.ConfigIncluderURL.includeURL. 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. Parameters context:ConfigIncludeContext some info about the include context what:URL the include statement's argument Returns:ConfigObject a non-null ConfigObject Annotations @Override

includeURL

back to summary

public ConfigObject includeURL(ConfigIncludeContext context, URL what)

Implements com.typesafe.config.ConfigIncluderURL.includeURL.

Doc from com.typesafe.config.ConfigIncluderURL.includeURL.

Parameters

context:ConfigIncludeContext: some info about the include context
what:URL: the include statement's argument

Returns:ConfigObject

a non-null ConfigObject

Annotations

@Override

withFallback	back to summary
public ConfigIncluder withFallback(ConfigIncluder fallback) Implements com.typesafe.config.ConfigIncluder.withFallback. Doc from com.typesafe.config.ConfigIncluder.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:ConfigIncluder the previous includer for chaining Returns:ConfigIncluder a new includer Annotations @Override

withFallback

back to summary

public ConfigIncluder withFallback(ConfigIncluder fallback)

Implements com.typesafe.config.ConfigIncluder.withFallback.

Doc from com.typesafe.config.ConfigIncluder.withFallback.

Parameters

fallback:ConfigIncluder: the previous includer for chaining

Returns:ConfigIncluder

a new includer

Annotations

@Override

pack-priv Class SimpleIncluder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface SimpleIncluder.NameSource

Method Summary

Method Detail

private Class SimpleIncluder.Proxy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SimpleIncluder.RelativeNameSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail