Package com.typesafe.config.impl

Class Parseable

java.lang.Object

com.typesafe.config.impl.Parseable

All Implemented Interfaces:

ConfigParseable

public abstract class Parseable
extends java.lang.Object
implements ConfigParseable

Internal implementation detail, not ABI stable, do not touch. For use only by the com.typesafe.config package. The point of this class is to avoid "propagating" each overload on "thing which can be parsed" through multiple interfaces. Most interfaces can have just one overload that takes a Parseable. Also it's used as an abstract "resource handle" in the ConfigIncluder interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	Parseable.Relativizer	Internal implementation detail, not ABI stable, do not touch.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Parseable()

Method Summary

Modifier and Type	Method	Description
protected abstract ConfigOrigin	createOrigin()
static Parseable	newFile(java.io.File input, ConfigParseOptions options)
static Parseable	newNotFound(java.lang.String whatNotFound, java.lang.String message, ConfigParseOptions options)
static Parseable	newProperties(java.util.Properties properties, ConfigParseOptions options)
static Parseable	newReader(java.io.Reader reader, ConfigParseOptions options)
static Parseable	newResources(java.lang.Class<?> klass, java.lang.String resource, ConfigParseOptions options)
static Parseable	newResources(java.lang.String resource, ConfigParseOptions options)
static Parseable	newString(java.lang.String input, ConfigParseOptions options)
static Parseable	newURL(java.net.URL input, ConfigParseOptions options)
ConfigParseOptions	options()	Get the initial options, which can be modified then passed to parse().
ConfigOrigin	origin()	Returns a ConfigOrigin describing the origin of the parseable item.
ConfigObject	parse()
ConfigObject	parse(ConfigParseOptions baseOptions)	Parse whatever it is.
ConfigDocument	parseConfigDocument()
protected void	postConstruct(ConfigParseOptions baseOptions)
protected ConfigDocument	rawParseDocument(ConfigOrigin origin, ConfigParseOptions finalOptions)
protected com.typesafe.config.impl.AbstractConfigValue	rawParseValue(ConfigOrigin origin, ConfigParseOptions finalOptions)
protected abstract java.io.Reader	reader()
protected java.io.Reader	reader(ConfigParseOptions options)
java.lang.String	toString()
protected static void	trace(java.lang.String message)

Methods inherited from class java.lang.Object

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

Constructor Detail

Parseable

protected Parseable()

Method Detail

postConstruct

protected void postConstruct(ConfigParseOptions baseOptions)

reader

protected abstract java.io.Reader reader()
                                  throws java.io.IOException

Throws:

java.io.IOException

reader

protected java.io.Reader reader(ConfigParseOptions options)
                         throws java.io.IOException

Throws:

java.io.IOException

trace

protected static void trace(java.lang.String message)

parse

public parse(ConfigParseOptions baseOptions)

Description copied from interface: ConfigParseable

Parse whatever it is. The options should come from options() but you could tweak them if you like.

Specified by:

parse in interface ConfigParseable

Parameters:

baseOptions - parse options, should be based on the ones from options()

Returns:

the parsed object

rawParseValue

protected com.typesafe.config.impl.AbstractConfigValue rawParseValue(ConfigOrigin origin,
                                                                     ConfigParseOptions finalOptions)
                                                              throws java.io.IOException

Throws:

java.io.IOException

rawParseDocument

protected rawParseDocument(ConfigOrigin origin,
                                          ConfigParseOptions finalOptions)
                                   throws java.io.IOException

Throws:

java.io.IOException

parse

public parse()

parseConfigDocument

public parseConfigDocument()

origin

public final origin()

Description copied from interface: ConfigParseable

Returns a ConfigOrigin describing the origin of the parseable item.

Specified by:

origin in interface ConfigParseable

Returns:

the origin of the parseable item

createOrigin

protected abstract createOrigin()

options

public options()

Description copied from interface: ConfigParseable

Get the initial options, which can be modified then passed to parse(). These options will have the right description, includer, and other parameters already set up.

Specified by:

options in interface ConfigParseable

Returns:

the initial options

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

newNotFound

public static newNotFound(java.lang.String whatNotFound,
                                    java.lang.String message,
                                    ConfigParseOptions options)

newReader

public static newReader(java.io.Reader reader,
                                  ConfigParseOptions options)

newString

public static newString(java.lang.String input,
                                  ConfigParseOptions options)

newURL

public static newURL(java.net.URL input,
                               ConfigParseOptions options)

newFile

public static newFile(java.io.File input,
                                ConfigParseOptions options)

newResources

public static newResources(java.lang.Class<?> klass,
                                     java.lang.String resource,
                                     ConfigParseOptions options)

newResources

public static newResources(java.lang.String resource,
                                     ConfigParseOptions options)

newProperties

public static newProperties(java.util.Properties properties,
                                      ConfigParseOptions options)