ConfigDocumentFactory

org.ekrich.config.parser.ConfigDocumentFactory

Factory for creating org.ekrich.config.parser.ConfigDocument instances.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def parseFile(file: File, options: ConfigParseOptions): ConfigDocument

Parses a file into a ConfigDocument instance.

Parses a file into a ConfigDocument instance.

Value parameters

file

the file to parse

options

parse options to control how the file is interpreted

Attributes

Returns

the parsed configuration

Throws
org.ekrich.config.ConfigException

on IO or parse errors

def parseFile(file: File): ConfigDocument

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

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

Value parameters

file

the file to parse

Attributes

Returns

the parsed configuration

Throws
org.ekrich.config.ConfigException

on IO or parse errors

def parseReader(reader: Reader, options: ConfigParseOptions): ConfigDocument

Parses a Reader into a ConfigDocument instance.

Parses a Reader into a ConfigDocument instance.

Value parameters

options

parse options to control how the reader is interpreted

reader

the reader to parse

Attributes

Returns

the parsed configuration

Throws
ConfigException

on IO or parse errors

def parseReader(reader: Reader): ConfigDocument

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

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

Value parameters

reader

the reader to parse

Attributes

Returns

the parsed configuration

Throws
org.ekrich.config.ConfigException

on IO or parse errors

def parseString(s: String, options: ConfigParseOptions): ConfigDocument

Parses a string which should be valid HOCON or JSON.

Parses a string which should be valid HOCON or JSON.

Value parameters

options

parse options

s

string to parse

Attributes

Returns

the parsed configuration

def parseString(s: String): ConfigDocument

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

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

Value parameters

s

string to parse

Attributes

Returns

the parsed configuration