ninja.leaping.configurate

Class ConfigurationOptions

java.lang.Object

ninja.leaping.configurate.ConfigurationOptions

public class ConfigurationOptions
extends Object

This object is a holder for general configuration options. This is meant to hold options that are used in configuring how the configuration data structures are handled, rather than the serialization configuration that is located in ConfigurationLoaders

Method Summary

Modifier and Type	Method and Description
boolean	acceptsType(Class<?> type) Return whether objects of the provided type are accepted as values for nodes with this as their options object.
static ConfigurationOptions	defaults() Create a new options object with defaults set
boolean	equals(Object o)
String	getHeader() Get the header used for this configuration
MapFactory	getMapFactory() Get the key comparator currently being used for this configuration
ObjectMapperFactory	getObjectMapperFactory() Get the current object mapper factory that is most appropriate to this configuration.
TypeSerializerCollection	getSerializers()
int	hashCode()
ConfigurationOptions	setAcceptedTypes(Set<Class<?>> acceptedTypes) Set types that will be accepted as native values for this configuration
ConfigurationOptions	setHeader(String header) Set the header that will be written to a file if
ConfigurationOptions	setMapFactory(MapFactory factory) Return a new options object with the provided option set.
ConfigurationOptions	setObjectMapperFactory(ObjectMapperFactory factory) Set the factory to use to produce object mapper instances for this configuration
ConfigurationOptions	setSerializers(TypeSerializerCollection serializers) Set the collection of TypeSerializers to be used for lookups
ConfigurationOptions	setShouldCopyDefaults(boolean shouldCopyDefaults) Set whether defaults should be set when used.
boolean	shouldCopyDefaults() Return whether or not default parameters provided to ConfigurationNode getter methods should be set to the node when used.

Methods inherited from class java.lang.Object

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

Method Detail

defaults

public static ConfigurationOptions defaults()

Create a new options object with defaults set

Returns:

A new default options object

getMapFactory

public MapFactory getMapFactory()

Get the key comparator currently being used for this configuration

Returns:

The active key comparator

setMapFactory

public ConfigurationOptions setMapFactory(MapFactory factory)

Return a new options object with the provided option set.

Parameters:

factory - The new factory to use to create a map

Returns:

The new options object

getHeader

public String getHeader()

Get the header used for this configuration

Returns:

The current header. Lines are split by \n,

setHeader

public ConfigurationOptions setHeader(String header)

Set the header that will be written to a file if

Parameters:

header - The new header to use for the configuration

Returns:

The map's header

getSerializers

public TypeSerializerCollection getSerializers()

setSerializers

public ConfigurationOptions setSerializers(TypeSerializerCollection serializers)

Set the collection of TypeSerializers to be used for lookups

Parameters:

serializers - The serializers to use

Returns:

updated options object

getObjectMapperFactory

public ObjectMapperFactory getObjectMapperFactory()

Get the current object mapper factory that is most appropriate to this configuration.

Returns:

The factory used to construct ObjectMapper instances

setObjectMapperFactory

public ConfigurationOptions setObjectMapperFactory(ObjectMapperFactory factory)

Set the factory to use to produce object mapper instances for this configuration

Parameters:

factory - The factory to use to produce object mapper instances. Must not be null

Returns:

updated options object

acceptsType

public boolean acceptsType(Class<?> type)

Return whether objects of the provided type are accepted as values for nodes with this as their options object.

Parameters:

type - The type to check

Returns:

Whether the type is accepted

setAcceptedTypes

public ConfigurationOptions setAcceptedTypes(Set<Class<?>> acceptedTypes)

Set types that will be accepted as native values for this configuration

Parameters:

acceptedTypes - The types that will be accepted to a call to ConfigurationNode.setValue(Object)

Returns:

updated options object

shouldCopyDefaults

public boolean shouldCopyDefaults()

Return whether or not default parameters provided to ConfigurationNode getter methods should be set to the node when used.

Returns:

Whether defaults should be copied into value

setShouldCopyDefaults

public ConfigurationOptions setShouldCopyDefaults(boolean shouldCopyDefaults)

Set whether defaults should be set when used.

Parameters:

shouldCopyDefaults - whether to copy defaults

Returns:

updated options object

See Also:

for information on what this method does

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object