net.lenni0451.optconfig

Class ConfigOptions

java.lang.Object

net.lenni0451.optconfig.ConfigOptions

public class ConfigOptions
extends java.lang.Object

The options to configure the behavior of the config loader.

Constructor Summary

Constructors

Constructor and Description
ConfigOptions()

Method Summary

Modifier and Type	Method and Description
ConfigOptions	setAddMissingOptions(boolean value) Set if missing options should be added to the config.
ConfigOptions	setClassAccessFactory(ClassAccessFactory classAccessFactory) Set the factory for the ClassAccess instances.
ConfigOptions	setCommentSpacing(int value) Set the spacing between the comment start and the comment text.
ConfigOptions	setNotReloadableComment(boolean value) Automatically add a comment to options that are marked with NotReloadable.
ConfigOptions	setRemoveUnknownOptions(boolean value) Set if unknown options should be removed from the config.
ConfigOptions	setResetInvalidOptions(boolean value) Set if invalid options should be reset to their default value.
ConfigOptions	setRewriteConfig(boolean value) Set if the config should be rewritten when loading it.
ConfigOptions	setSpaceBetweenOptions(boolean value) Set if there should be an empty line between each option.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigOptions

public ConfigOptions()

Method Detail

setResetInvalidOptions

public ConfigOptions setResetInvalidOptions(boolean value)

Set if invalid options should be reset to their default value.
Default: false

Parameters:

value - The new value

Returns:

The config options

setRemoveUnknownOptions

public ConfigOptions setRemoveUnknownOptions(boolean value)

Set if unknown options should be removed from the config.
Default: true

Parameters:

value - The new value

Returns:

The config options

setAddMissingOptions

public ConfigOptions setAddMissingOptions(boolean value)

Set if missing options should be added to the config.
The default values will be used for the missing options.
Default: true

Parameters:

value - The new value

Returns:

The config options

setCommentSpacing

public ConfigOptions setCommentSpacing(int value)

Set the spacing between the comment start and the comment text.
Spaces will be added to the comment until the desired spacing is reached.
Default: 0

Parameters:

value - The new value

Returns:

The config options

setRewriteConfig

public ConfigOptions setRewriteConfig(boolean value)

Set if the config should be rewritten when loading it.
This will remove all user comments and formatting.
Option values are not affected by this.
Default: false

Parameters:

value - The new value

Returns:

The config options

setSpaceBetweenOptions

public ConfigOptions setSpaceBetweenOptions(boolean value)

Set if there should be an empty line between each option.
Default: true

Parameters:

value - The new value

Returns:

The config options

setNotReloadableComment

public ConfigOptions setNotReloadableComment(boolean value)

Automatically add a comment to options that are marked with NotReloadable.
Default: true

Parameters:

value - The new value

Returns:

The config options

setClassAccessFactory

public ConfigOptions setClassAccessFactory(ClassAccessFactory classAccessFactory)

Set the factory for the ClassAccess instances.
Default: ReflectionClassAccess

Parameters:

classAccessFactory - The new factory

Returns:

The config options