ninja.leaping.configurate.loader

Interface ConfigurationLoader<NodeType extends ConfigurationNode>

All Known Implementing Classes:

AbstractConfigurationLoader, GsonConfigurationLoader, HoconConfigurationLoader, JSONConfigurationLoader, YAMLConfigurationLoader

public interface ConfigurationLoader<NodeType extends ConfigurationNode>

Loader for a specific configuration format

Method Summary

Modifier and Type	Method and Description
default NodeType	createEmptyNode() Return an empty node of the most appropriate type for this loader, using the default options.
NodeType	createEmptyNode(ConfigurationOptions options) Return an empty node of the most appropriate type for this loader
ConfigurationOptions	getDefaultOptions() Get the default options that any new nodes will be created with if no options object is passed.
default NodeType	load() Create a new configuration node populated with the appropriate data.
NodeType	load(ConfigurationOptions options) Create a new configuration node populated with the appropriate data, structured with the provided options.
void	save(ConfigurationNode node) Save the contents of the given node tree to this loader.

Method Detail

getDefaultOptions

ConfigurationOptions getDefaultOptions()

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

Returns:

The default options

load

default NodeType load()
               throws IOException

Create a new configuration node populated with the appropriate data.

Returns:

The newly constructed node

Throws:

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

load

NodeType load(ConfigurationOptions options)
       throws IOException

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

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

save

void save(ConfigurationNode node)
   throws IOException

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

Parameters:

node - The node a save is being requested for

Throws:

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

createEmptyNode

default NodeType createEmptyNode()

Return an empty node of the most appropriate type for this loader, using the default options.

Returns:

The appropriate node type

createEmptyNode

NodeType createEmptyNode(ConfigurationOptions options)

Return an empty node of the most appropriate type for this loader

Parameters:

options - The options to use with this node. Must not be null (take a look at ConfigurationOptions.defaults())

Returns:

The appropriate node type