com.typesafe.config
Class ConfigResolveOptions

java.lang.Object
  com.typesafe.config.ConfigResolveOptions

public final class ConfigResolveOptions
extends Object

A set of options related to resolving substitutions. Substitutions use the ${foo.bar} syntax and are documented in the HOCON spec.

This object is immutable, so the "setters" return a new object.

Here is an example of creating a custom ConfigResolveOptions:

     ConfigResolveOptions options = ConfigResolveOptions.defaults()
         .setUseSystemEnvironment(false)
 

In addition to defaults(), there's a prebuilt noSystem() which avoids looking at any system environment variables or other external system information. (Right now, environment variables are the only example.)

Method Summary

static ConfigResolveOptions	defaults() Returns the default resolve options.
boolean	getUseSystemEnvironment() Returns whether the options enable use of system environment variables.
static ConfigResolveOptions	noSystem() Returns resolve options that disable any reference to "system" data (currently, this means environment variables).
ConfigResolveOptions	setUseSystemEnvironment(boolean value) Returns options with use of environment variables set to the given value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

defaults

public static ConfigResolveOptions defaults()

Returns the default resolve options.

Returns:

the default resolve options

noSystem

public static ConfigResolveOptions noSystem()

Returns resolve options that disable any reference to "system" data (currently, this means environment variables).

Returns:

the resolve options with env variables disabled

setUseSystemEnvironment

public ConfigResolveOptions setUseSystemEnvironment(boolean value)

Returns options with use of environment variables set to the given value.

Parameters:

value - true to resolve substitutions falling back to environment variables.

Returns:

options with requested setting for use of environment variables

getUseSystemEnvironment

public boolean getUseSystemEnvironment()

Returns whether the options enable use of system environment variables. This method is mostly used by the config lib internally, not by applications.

Returns:

true if environment variables should be used