ninja.leaping.configurate.loader

Class AbstractConfigurationLoader<NodeType extends ConfigurationNode>

java.lang.Object

ninja.leaping.configurate.loader.AbstractConfigurationLoader<NodeType>

All Implemented Interfaces:

ConfigurationLoader<NodeType>

Direct Known Subclasses:

GsonConfigurationLoader, HoconConfigurationLoader, JSONConfigurationLoader, YAMLConfigurationLoader

public abstract class AbstractConfigurationLoader<NodeType extends ConfigurationNode>
extends Object
implements ConfigurationLoader<NodeType>

Base class for many stream-based configuration loaders. This class provides conversion from a variety of input sources to CharSource/Sink objects, providing a consistent API for loaders to read from and write to. Either the source or sink may be null. If this is true, this loader may not support either loading or saving. In this case, implementing classes are expected to throw an IOException.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractConfigurationLoader.Builder<T extends AbstractConfigurationLoader.Builder>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIGURATE_LINE_SEPARATOR
protected static Splitter	LINE_SPLITTER
protected Callable<BufferedReader>	source
protected static String	SYSTEM_LINE_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConfigurationLoader(AbstractConfigurationLoader.Builder<?> builder, CommentHandler[] commentHandlers)

Method Summary

Modifier and Type	Method and Description
boolean	canLoad()
boolean	canSave()
CommentHandler	getDefaultCommentHandler()
ConfigurationOptions	getDefaultOptions() Get the default options that any new nodes will be created with if no options object is passed.
NodeType	load(ConfigurationOptions options) Create a new configuration node populated with the appropriate data, structured with the provided options.
protected abstract void	loadInternal(NodeType node, BufferedReader reader)
void	save(ConfigurationNode node) Save the contents of the given node tree to this loader.
protected abstract void	saveInternal(ConfigurationNode node, Writer writer)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ninja.leaping.configurate.loader.ConfigurationLoader

createEmptyNode, createEmptyNode, load

Field Detail

CONFIGURATE_LINE_SEPARATOR

public static final String CONFIGURATE_LINE_SEPARATOR

See Also:

Constant Field Values

LINE_SPLITTER

protected static final Splitter LINE_SPLITTER

SYSTEM_LINE_SEPARATOR

protected static final String SYSTEM_LINE_SEPARATOR

source

protected final Callable<BufferedReader> source

Constructor Detail

AbstractConfigurationLoader

protected AbstractConfigurationLoader(AbstractConfigurationLoader.Builder<?> builder,
                                      CommentHandler[] commentHandlers)

Method Detail

getDefaultCommentHandler

public CommentHandler getDefaultCommentHandler()

load

public NodeType load(ConfigurationOptions options)
              throws IOException

Description copied from interface: ConfigurationLoader

Create a new configuration node populated with the appropriate data, structured with the provided options.

Specified by:

load in interface ConfigurationLoader<NodeType extends ConfigurationNode>

Parameters:

options - The options to load with

Returns:

The newly constructed node

Throws:

IOException - if any sort of error occurs with reading or parsing the configuration

loadInternal

protected abstract void loadInternal(NodeType node,
                                     BufferedReader reader)
                              throws IOException

Throws:

IOException

save

public void save(ConfigurationNode node)
          throws IOException

Description copied from interface: ConfigurationLoader

Save the contents of the given node tree to this loader.

Specified by:

save in interface ConfigurationLoader<NodeType extends ConfigurationNode>

Parameters:

node - The node a save is being requested for

Throws:

IOException - if any sort of error occurs with writing or generating the configuration

saveInternal

protected abstract void saveInternal(ConfigurationNode node,
                                     Writer writer)
                              throws IOException

Throws:

IOException

getDefaultOptions

public ConfigurationOptions getDefaultOptions()

Get the default options that any new nodes will be created with if no options object is passed.

Specified by:

getDefaultOptions in interface ConfigurationLoader<NodeType extends ConfigurationNode>

Returns:

The default options

canLoad

public boolean canLoad()

canSave

public boolean canSave()