Package space.arim.dazzleconf.ext.snakeyaml

Class SnakeYamlConfigurationFactory<C>

java.lang.Object

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

space.arim.dazzleconf.ext.snakeyaml.SnakeYamlConfigurationFactory<C>

Type Parameters:

C - the configuration type

All Implemented Interfaces:

ConfigurationFactory<C>

public class SnakeYamlConfigurationFactory<C>
extends AbstractConfigurationFactory<C>

A ConfigurationFactory implementation using SnakeYAML to load a yaml configuration.

Note: Relying on the identity of this class is deprecated, for example relying on this class implementing ConfigurationFactory. In a future major release, the implementation of the factory returned from the create methods may be refactored.

Author:

A248

Constructor Summary

Constructors

Constructor	Description
SnakeYamlConfigurationFactory(Class<C> configClazz, ConfigurationOptions options)	Deprecated. Use create(Class, ConfigurationOptions).
SnakeYamlConfigurationFactory(Class<C> configClazz, ConfigurationOptions options, SnakeYamlOptions yamlOptions)	Deprecated. Use create(Class, ConfigurationOptions, SnakeYamlOptions).

Method Summary

Modifier and Type	Method	Description
protected Charset	charset()
static <C> ConfigurationFactory<C>	create(Class<C> configClass, ConfigurationOptions options)	Creates from a configuration class and config options.
static <C> ConfigurationFactory<C>	create(Class<C> configClass, ConfigurationOptions options, SnakeYamlOptions yamlOptions)	Creates from a configuration class, config options, and SnakeYamlOptions
Class<C>	getConfigClass()
ConfigurationOptions	getOptions()
C	load(InputStream arg0)
C	load(InputStream arg0, C arg1)
C	load(ReadableByteChannel arg0)
C	load(ReadableByteChannel arg0, C arg1)
C	loadDefaults()
protected Map<String,Object>	loadMapFromReader(Reader reader)
protected boolean	supportsCommentsThroughWrapper()
void	write(C arg0, OutputStream arg1)
void	write(C arg0, WritableByteChannel arg1)
protected void	writeMapToWriter(Map<String,Object> rawMap, Writer writer)

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

getHeader, pseudoCommentsSuffix

Methods inherited from class java.lang.Object

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

Constructor Details

SnakeYamlConfigurationFactory

@Deprecated
public SnakeYamlConfigurationFactory(Class<C> configClazz,
 ConfigurationOptions options,
 SnakeYamlOptions yamlOptions)

Deprecated.

Use create(Class, ConfigurationOptions, SnakeYamlOptions). Subclassing should not be used; prefer the delegation pattern instead. See the class javadoc for more info.

Creates from a configuration class, config options, and SnakeYamlOptions

Parameters:

configClazz - the config class

options - the config options

yamlOptions - the snake yaml options

Throws:

IllegalArgumentException - if configClazz is not an interface

IllDefinedConfigException - if a configuration entry in configClazz is not defined properly

SnakeYamlConfigurationFactory

@Deprecated
public SnakeYamlConfigurationFactory(Class<C> configClazz,
 ConfigurationOptions options)

Deprecated.

Use create(Class, ConfigurationOptions). Subclassing should not be used; prefer the delegation pattern instead. See the class javadoc for more info.

Creates from a configuration class and config options, using the default SnakeYamlOptions (including "block" flow style and UTF 8)

Parameters:

configClazz - the config class

options - the config options

Throws:

IllegalArgumentException - if configClazz is not an interface

IllDefinedConfigException - if a configuration entry in configClazz is not defined properly

Method Details

create

public static <C> ConfigurationFactory<C> create(Class<C> configClass,
 ConfigurationOptions options,
 SnakeYamlOptions yamlOptions)

Creates from a configuration class, config options, and SnakeYamlOptions

Type Parameters:

C - the configuration type

Parameters:

configClass - the config class

options - the config options

yamlOptions - the snake yaml options

Returns:

the configuration factory

Throws:

IllegalArgumentException - if configClass is not an interface

IllDefinedConfigException - if a configuration entry in configClass is not defined properly

create

public static <C> ConfigurationFactory<C> create(Class<C> configClass,
 ConfigurationOptions options)

Creates from a configuration class and config options.

Uses the default yaml options, which include "block" flow style and UTF 8 encoding

Type Parameters:

C - the configuration type

Parameters:

configClass - the config class

options - the config options

Returns:

the configuration factory

Throws:

IllegalArgumentException - if configClass is not an interface

IllDefinedConfigException - if a configuration entry in configClass is not defined properly

supportsCommentsThroughWrapper

protected boolean supportsCommentsThroughWrapper()

Overrides:

supportsCommentsThroughWrapper in class AbstractConfigurationFactory<C>

charset

protected Charset charset()

Specified by:

charset in class AbstractConfigurationFactory<C>

loadMapFromReader

protected Map<String,Object> loadMapFromReader(Reader reader)
                                        throws IOException,
ConfigFormatSyntaxException

Specified by:

loadMapFromReader in class AbstractConfigurationFactory<C>

Throws:

IOException

ConfigFormatSyntaxException

writeMapToWriter

protected void writeMapToWriter(Map<String,Object> rawMap,
 Writer writer)
                         throws IOException

Specified by:

writeMapToWriter in class AbstractConfigurationFactory<C>

Throws:

IOException

getConfigClass

public Class<C> getConfigClass()

Specified by:

getConfigClass in interface ConfigurationFactory<C>

getOptions

public ConfigurationOptions getOptions()

Specified by:

getOptions in interface ConfigurationFactory<C>

load

public C load(ReadableByteChannel arg0)
       throws IOException,
InvalidConfigException

Specified by:

load in interface ConfigurationFactory<C>

Throws:

IOException

InvalidConfigException

load

public C load(InputStream arg0)
       throws IOException,
InvalidConfigException

Specified by:

load in interface ConfigurationFactory<C>

Throws:

IOException

InvalidConfigException

load

public C load(ReadableByteChannel arg0,
 C arg1)
       throws IOException,
InvalidConfigException

Specified by:

load in interface ConfigurationFactory<C>

Throws:

IOException

InvalidConfigException

load

public C load(InputStream arg0,
 C arg1)
       throws IOException,
InvalidConfigException

Specified by:

load in interface ConfigurationFactory<C>

Throws:

IOException

InvalidConfigException

loadDefaults

public C loadDefaults()

Specified by:

loadDefaults in interface ConfigurationFactory<C>

write

public void write(C arg0,
 WritableByteChannel arg1)
           throws IOException

Specified by:

write in interface ConfigurationFactory<C>

Throws:

IOException

write

public void write(C arg0,
 OutputStream arg1)
           throws IOException

Specified by:

write in interface ConfigurationFactory<C>

Throws:

IOException