Top Fields Constructors Methods
com.typesafe.config.impl

pack-priv Class SimpleIncludeContext

extends Object
implements ConfigIncludeContext
Class Inheritance
All Implemented Interfaces
com.typesafe.config.ConfigIncludeContext
Imports
com.typesafe.config.ConfigIncludeContext, .ConfigParseOptions, .ConfigParseable

Field Summary

Modifier and TypeField and Description
private final ConfigParseOptions
options

private final Parseable
parseable

Constructor Summary

AccessConstructor and Description
pack-priv
SimpleIncludeContext(Parseable parseable)

private
SimpleIncludeContext(Parseable parseable, ConfigParseOptions options)

Method Summary

Modifier and TypeMethod and Description
public ConfigParseOptions
parseOptions()

Implements com.typesafe.config.ConfigIncludeContext.parseOptions.

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

public ConfigParseable
relativeTo(String
the name to make relative to the resource doing the including
filename)

Implements com.typesafe.config.ConfigIncludeContext.relativeTo.

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
setParseOptions(ConfigParseOptions
new parse options to use
options)

Implements com.typesafe.config.ConfigIncludeContext.setParseOptions.

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

pack-priv SimpleIncludeContext
withParseable(Parseable parseable)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

optionsback to summary
private final ConfigParseOptions options
parseableback to summary
private final Parseable parseable

Constructor Detail

SimpleIncludeContextback to summary
pack-priv SimpleIncludeContext(Parseable parseable)
SimpleIncludeContextback to summary
private SimpleIncludeContext(Parseable parseable, ConfigParseOptions options)

Method Detail

parseOptionsback to summary
public ConfigParseOptions parseOptions()

Implements com.typesafe.config.ConfigIncludeContext.parseOptions.

Doc from com.typesafe.config.ConfigIncludeContext.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

Annotations
@Override
relativeToback to summary
public ConfigParseable relativeTo(String filename)

Implements com.typesafe.config.ConfigIncludeContext.relativeTo.

Doc from com.typesafe.config.ConfigIncludeContext.relativeTo.

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

Annotations
@Override
setParseOptionsback to summary
public ConfigIncludeContext setParseOptions(ConfigParseOptions options)

Implements com.typesafe.config.ConfigIncludeContext.setParseOptions.

Doc from com.typesafe.config.ConfigIncludeContext.setParseOptions.

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

Annotations
@Override
withParseableback to summary
pack-priv SimpleIncludeContext withParseable(Parseable parseable)