Package com.github.mizool.core.configuration

Class Config

java.lang.Object

com.github.mizool.core.configuration.Config

public final class Config
extends Object

Main entry point for the configuration API.

Method Summary

Modifier and Type	Method	Description
static RootNode	blank()	Deprecated, for removal: This API element is subject to removal in a future version. Use Sources.blank() instead.
static RootNode	from(Source source)	Creates a root node encapsulating access to the given Source instance.
static RootNode	from(InputStream inputStream, Charset charset)	Consumes the input stream and returns a root node encapsulating access to its properties.
static RootNode	from(Reader reader)	Consumes the given reader and returns a root node encapsulating access to its properties.
static RootNode	from(Properties properties)	Creates a root node encapsulating access to the given Properties instance.
static RootNode	systemProperties()	Creates a root node encapsulating access to the current system properties.

Methods inherited from class java.lang.Object

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

Method Details

from

public static RootNode from(Source source)

Creates a root node encapsulating access to the given Source instance.

blank

@Deprecated(since="8.3",
            forRemoval=true)
public static RootNode blank()

Deprecated, for removal: This API element is subject to removal in a future version.

Use Sources.blank() instead.

Creates a root node without any properties. Usually used as a starting point followed by multiple RootNode.add() calls.

See Also:

• RootNode.add(Reader)
• RootNode.add(InputStream, Charset)

systemProperties

public static RootNode systemProperties()

Creates a root node encapsulating access to the current system properties.

from

public static RootNode from(Properties properties)

Creates a root node encapsulating access to the given Properties instance.

from

public static RootNode from(Reader reader)

Consumes the given reader and returns a root node encapsulating access to its properties.

from

public static RootNode from(InputStream inputStream,
 Charset charset)

Consumes the input stream and returns a root node encapsulating access to its properties.

Parameters:

inputStream - the input stream to load from

charset - the charset to use