Top Description Methods
com.typesafe.config

public Interface ConfigParseable

Known Direct Implementers
com.typesafe.config.impl.Parseable
An opaque handle to something that can be parsed, obtained from ConfigIncludeContext.

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 initial options
options()

Get the initial options, which can be modified then passed to parse().

public ConfigOrigin

Returns:

the origin of the parseable item
origin()

Returns a ConfigOrigin describing the origin of the parseable item.

public ConfigObject

Returns:

the parsed object
parse(ConfigParseOptions
parse options, should be based on the ones from options()
options)

Parse whatever it is.

Method Detail

optionsback to summary
public ConfigParseOptions options()

Get the initial options, which can be modified then passed to parse(). These options will have the right description, includer, and other parameters already set up.

Returns:ConfigParseOptions

the initial options

originback to summary
public ConfigOrigin origin()

Returns a ConfigOrigin describing the origin of the parseable item.

Returns:ConfigOrigin

the origin of the parseable item

parseback to summary
public ConfigObject parse(ConfigParseOptions options)

Parse whatever it is. The options should come from options() but you could tweak them if you like.

Parameters
options:ConfigParseOptions

parse options, should be based on the ones from options()

Returns:ConfigObject

the parsed object