Top Description Methods
com.typesafe.config

public Interface ConfigIncludeContext

Known Direct Implementers
com.typesafe.config.impl.SimpleIncludeContext

Context provided to a ConfigIncluder; this interface is only useful inside a ConfigIncluder implementation, and is not intended for apps to implement.

Do not implement this interface; it should only be implemented by the config library. Arbitrary implementations will not work because the library internals assume a specific concrete implementation. Also, this interface is likely to grow new methods over time, so third-party implementations will break.

Method Summary

Modifier and TypeMethod and Description
public ConfigParseOptions

Returns:

the parse options
parseOptions
()

Parse options to use (if you use another method to get a ConfigParseable then use ConfigParseable#options() instead though).

public ConfigParseable

Returns:

parseable item relative to the resource doing the including, or null
relativeTo
(String
the name to make relative to the resource doing the including
filename
)

Tries to find a name relative to whatever is doing the including, for example in the same directory as the file doing the including.

public ConfigIncludeContext

Returns:

the updated copy of this context
setParseOptions
(ConfigParseOptions
new parse options to use
options
)

Copy this ConfigIncludeContext giving it a new value for its parseOptions.

Method Detail

parseOptionsback to summary
public ConfigParseOptions parseOptions()

Parse options to use (if you use another method to get a ConfigParseable then use ConfigParseable#options() instead though).

Returns:ConfigParseOptions

the parse options

relativeToback to summary
public ConfigParseable relativeTo(String filename)

Tries to find a name relative to whatever is doing the including, for example in the same directory as the file doing the including. Returns null if it can't meaningfully create a relative name. The returned parseable may not exist; this function is not required to do any IO, just compute what the name would be. The passed-in filename has to be a complete name (with extension), not just a basename. (Include statements in config files are allowed to give just a basename.)

Parameters
filename:String

the name to make relative to the resource doing the including

Returns:ConfigParseable

parseable item relative to the resource doing the including, or null

setParseOptionsback to summary
public ConfigIncludeContext setParseOptions(ConfigParseOptions options)

Copy this ConfigIncludeContext giving it a new value for its parseOptions.

Parameters
options:ConfigParseOptions

new parse options to use

Returns:ConfigIncludeContext

the updated copy of this context