Typesafe Config 1.4.3 · com.typesafe.config.parser.ConfigDocumentFactory

Access	Constructor and Description
public	ConfigDocumentFactory()

Method Summary

Modifier and Type	Method and Description
public static ConfigDocument	Returns: the parsed configuration parseFile(File the file to parse file, ConfigParseOptions parse options to control how the file is interpreted options) Parses a file into a ConfigDocument instance.
public static ConfigDocument	Returns: the parsed configuration parseFile(File the file to parse file) Parses a file into a ConfigDocument instance as with `parseFile(File, ConfigParseOptions)` but always uses the default parse options.
public static ConfigDocument	Returns: the parsed configuration parseReader(Reader the reader to parse reader, ConfigParseOptions parse options to control how the reader is interpreted options) Parses a Reader into a ConfigDocument instance.
public static ConfigDocument	Returns: the parsed configuration parseReader(Reader the reader to parse reader) Parses a reader into a Config instance as with `parseReader(Reader, ConfigParseOptions)` but always uses the default parse options.
public static ConfigDocument	Returns: the parsed configuration parseString(String string to parse s, ConfigParseOptions parse options options) Parses a string which should be valid HOCON or JSON.
public static ConfigDocument	Returns: the parsed configuration parseString(String string to parse s) Parses a string (which should be valid HOCON or JSON).

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

ConfigDocumentFactory	back to summary
public ConfigDocumentFactory()

Method Detail

parseFile	back to summary
public static ConfigDocument parseFile(File file, ConfigParseOptions options) Parses a file into a ConfigDocument instance. Parameters file:File the file to parse options:ConfigParseOptions parse options to control how the file is interpreted Returns:ConfigDocument the parsed configuration Exceptions ConfigException: on IO or parse errors

parseFile

back to summary

public static ConfigDocument parseFile(File file, ConfigParseOptions options)

Parses a file into a ConfigDocument instance.

Parameters

file:File: the file to parse
options:ConfigParseOptions: parse options to control how the file is interpreted

Returns:ConfigDocument

the parsed configuration

Exceptions

ConfigException:: on IO or parse errors

parseFile back to summary

parseFile	back to summary
public static ConfigDocument parseFile(File file) Parses a file into a ConfigDocument instance as with `parseFile(File, ConfigParseOptions)` but always uses the default parse options. Parameters file:File the file to parse Returns:ConfigDocument the parsed configuration Exceptions ConfigException: on IO or parse errors

public static ConfigDocument parseFile(File file)

Parses a file into a ConfigDocument instance as with parseFile(File, ConfigParseOptions) but always uses the default parse options.

Parameters

file:File: the file to parse

Returns:ConfigDocument

the parsed configuration

Exceptions

ConfigException:: on IO or parse errors

parseReader	back to summary
public static ConfigDocument parseReader(Reader reader, ConfigParseOptions options) Parses a Reader into a ConfigDocument instance. Parameters reader:Reader the reader to parse options:ConfigParseOptions parse options to control how the reader is interpreted Returns:ConfigDocument the parsed configuration Exceptions ConfigException: on IO or parse errors

parseReader

back to summary

public static ConfigDocument parseReader(Reader reader, ConfigParseOptions options)

Parses a Reader into a ConfigDocument instance.

Parameters

reader:Reader: the reader to parse
options:ConfigParseOptions: parse options to control how the reader is interpreted

Returns:ConfigDocument

the parsed configuration

Exceptions

ConfigException:: on IO or parse errors

parseReader back to summary

parseReader	back to summary
public static ConfigDocument parseReader(Reader reader) Parses a reader into a Config instance as with `parseReader(Reader, ConfigParseOptions)` but always uses the default parse options. Parameters reader:Reader the reader to parse Returns:ConfigDocument the parsed configuration Exceptions ConfigException: on IO or parse errors

public static ConfigDocument parseReader(Reader reader)

Parses a reader into a Config instance as with parseReader(Reader, ConfigParseOptions) but always uses the default parse options.

Parameters

reader:Reader: the reader to parse

Returns:ConfigDocument

the parsed configuration

Exceptions

ConfigException:: on IO or parse errors

parseString	back to summary
public static ConfigDocument parseString(String s, ConfigParseOptions options) Parses a string which should be valid HOCON or JSON. Parameters s:String string to parse options:ConfigParseOptions parse options Returns:ConfigDocument the parsed configuration

parseString

back to summary

public static ConfigDocument parseString(String s, ConfigParseOptions options)

Parses a string which should be valid HOCON or JSON.

Parameters

s:String: string to parse
options:ConfigParseOptions: parse options

Returns:ConfigDocument

the parsed configuration

parseString	back to summary
public static ConfigDocument parseString(String s) Parses a string (which should be valid HOCON or JSON). Uses the default parse options. Parameters s:String string to parse Returns:ConfigDocument the parsed configuration

parseString

back to summary

public static ConfigDocument parseString(String s)

Parses a string (which should be valid HOCON or JSON). Uses the default parse options.

Parameters

s:String: string to parse

Returns:ConfigDocument

the parsed configuration

public final Class ConfigDocumentFactory

Constructor Summary

Method Summary

Constructor Detail

Method Detail