Package space.arim.dazzleconf.factory

Class HumanReadableConfigurationFactory<C>

java.lang.Object

space.arim.dazzleconf.factory.ConfigurationFormatFactory<C>

space.arim.dazzleconf.factory.HumanReadableConfigurationFactory<C>

Type Parameters:

C - the type of the configuration

All Implemented Interfaces:

ConfigurationFactory<C>

public abstract class HumanReadableConfigurationFactory<C>
extends ConfigurationFormatFactory<C>

Extension of ConfigurationFormatFactory which turns ReadableByteChannel and InputStream into Reader and WritableByteChannel and OutputStream into Writer. Performs buffering as well.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HumanReadableConfigurationFactory(Class<C> configClass, ConfigurationOptions options)	Creates from a config class and config options

Method Summary

Modifier and Type	Method	Description
abstract Charset	charset()	Gets the charset which will be used to create readers and writers
Map<String,Object>	loadMap(InputStream inputStream)	Loads a map of config values from an input stream.
abstract Map<String,Object>	loadMap(Reader reader)	Loads a map of config values from a reader
Map<String,Object>	loadMap(ReadableByteChannel readChannel)	Loads a map of config values from an input channel.
void	writeMap(Map<String,Object> config, OutputStream outputStream)	Writes a map of config values to an output stream
abstract void	writeMap(Map<String,Object> config, Writer writer)	Writes a map of config values to a writer
void	writeMap(Map<String,Object> config, WritableByteChannel writeChannel)	Writes a map of config values to an output channel

Methods inherited from class space.arim.dazzleconf.factory.ConfigurationFormatFactory

getConfigClass, getHeader, getOptions, load, load, load, load, loadDefaults, pseudoCommentsSuffix, supportsCommentsThroughWrapper, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

HumanReadableConfigurationFactory

protected HumanReadableConfigurationFactory(Class<C> configClass,
 ConfigurationOptions options)

Creates from a config class and config options

Parameters:

configClass - the config class

options - configuration options

Throws:

NullPointerException - if configClass or options is null

IllegalArgumentException - if configClass is not an interface

IllDefinedConfigException - if the configuration entries defined in the config class are invalid

Method Details

charset

public abstract Charset charset()

Gets the charset which will be used to create readers and writers

Returns:

the charset

loadMap

public final Map<String,Object> loadMap(ReadableByteChannel readChannel)
                                 throws IOException,
InvalidConfigException

Description copied from class: ConfigurationFormatFactory

Loads a map of config values from an input channel.

Specified by:

loadMap in class ConfigurationFormatFactory<C>

Parameters:

readChannel - the channel from which to read

Returns:

the hierarchical configuration map

Throws:

IOException - if an I/O error occurs

InvalidConfigException - if the configuration format dictates the data is not valid syntax. Usually ConfigFormatSyntaxException

loadMap

public final Map<String,Object> loadMap(InputStream inputStream)
                                 throws IOException,
InvalidConfigException

Description copied from class: ConfigurationFormatFactory

Loads a map of config values from an input stream.

Specified by:

loadMap in class ConfigurationFormatFactory<C>

Parameters:

inputStream - the stream from which to read

Returns:

the hierarchical configuration map

Throws:

IOException - if an I/O error occurs

InvalidConfigException - if the configuration format dictates the data is not valid syntax. Usually ConfigFormatSyntaxException

loadMap

public abstract Map<String,Object> loadMap(Reader reader)
                                    throws IOException,
InvalidConfigException

Loads a map of config values from a reader

Parameters:

reader - the reader

Returns:

the hierarchical configuration map

Throws:

IOException - if an I/O error occurs

InvalidConfigException - if the configuration format dictates the data is not valid syntax. * Usually ConfigFormatSyntaxException

writeMap

public final void writeMap(Map<String,Object> config,
 WritableByteChannel writeChannel)
                    throws IOException

Description copied from class: ConfigurationFormatFactory

Writes a map of config values to an output channel

Specified by:

writeMap in class ConfigurationFormatFactory<C>

Parameters:

config - the hierarchical configuration map

writeChannel - the channel to which to write

Throws:

IOException - if an I/O error occurs

writeMap

public final void writeMap(Map<String,Object> config,
 OutputStream outputStream)
                    throws IOException

Description copied from class: ConfigurationFormatFactory

Writes a map of config values to an output stream

Specified by:

writeMap in class ConfigurationFormatFactory<C>

Parameters:

config - the hierarchical configuration map

outputStream - the stream to which to write

Throws:

IOException - if an I/O error occurs

writeMap

public abstract void writeMap(Map<String,Object> config,
 Writer writer)
                       throws IOException

Writes a map of config values to a writer

Parameters:

config - the hierarchical configuration map

writer - the writer

Throws:

IOException - if an I/O error occurs