sconfig/org.ekrich.config.parser/ConfigDocumentFactory

ConfigDocumentFactory

object ConfigDocumentFactory
Factory for creating
org.ekrich.config.parser.ConfigDocument instances.
class Object
trait Matchable
class Any

Value members

Methods

def parseReader(reader: Reader, options: ConfigParseOptions): ConfigDocument
Parses a Reader into a ConfigDocument instance.
Value Params
options
parse options to control how the reader is interpreted
reader
the reader to parse
Returns
the parsed configuration
Throws
ConfigException
ConfigException
def parseReader(reader: Reader): ConfigDocument
Parses a reader into a Config instance as with
parseReader(Reader, ConfigParseOptions)
but always uses the default parse options.
Value Params
reader
the reader to parse
Returns
the parsed configuration
Throws
org.ekrich.config.ConfigException
org.ekrich.config.ConfigException
def parseFile(file: File, options: ConfigParseOptions): ConfigDocument
Parses a file into a ConfigDocument instance.
Value Params
file
the file to parse
options
parse options to control how the file is interpreted
Returns
the parsed configuration
Throws
org.ekrich.config.ConfigException
org.ekrich.config.ConfigException
def parseFile(file: File): ConfigDocument
Parses a file into a ConfigDocument instance as with
parseFile(File, ConfigParseOptions)
but always uses the default parse options.
Value Params
file
the file to parse
Returns
the parsed configuration
Throws
org.ekrich.config.ConfigException
org.ekrich.config.ConfigException
def parseString(s: String, options: ConfigParseOptions): ConfigDocument
Parses a string which should be valid HOCON or JSON.
Value Params
options
parse options
s
string to parse
Returns
the parsed configuration
def parseString(s: String): ConfigDocument
Parses a string (which should be valid HOCON or JSON). Uses the
default parse options.
Value Params
s
string to parse
Returns
the parsed configuration