Index

A B C D F G I M N O R S T V Y
All Classes|All Packages

A

addClassTag(Class<? extends Object>, Tag) - Method in class be.dezijwegel.betteryaml.representer.CustomRepresenter

addFormatter(Class<?>, IFormatter) - Method in class be.dezijwegel.betteryaml.formatting.CustomFormatter

Allows public modification, will very likely remain unused

addValidator(String, Validator) - Method in class be.dezijwegel.betteryaml.validation.ValidationHandler

B

be.dezijwegel.betteryaml - package be.dezijwegel.betteryaml

be.dezijwegel.betteryaml.files - package be.dezijwegel.betteryaml.files

be.dezijwegel.betteryaml.formatting - package be.dezijwegel.betteryaml.formatting

be.dezijwegel.betteryaml.interfaces - package be.dezijwegel.betteryaml.interfaces

be.dezijwegel.betteryaml.representer - package be.dezijwegel.betteryaml.representer

be.dezijwegel.betteryaml.testplugin - package be.dezijwegel.betteryaml.testplugin

be.dezijwegel.betteryaml.util - package be.dezijwegel.betteryaml.util

be.dezijwegel.betteryaml.validation - package be.dezijwegel.betteryaml.validation

be.dezijwegel.betteryaml.validation.validator - package be.dezijwegel.betteryaml.validation.validator

be.dezijwegel.betteryaml.validation.validator.numeric - package be.dezijwegel.betteryaml.validation.validator.numeric

be.dezijwegel.betteryaml.validation.validator.string - package be.dezijwegel.betteryaml.validation.validator.string

BetterLang - Class in be.dezijwegel.betteryaml

BetterLang wraps BetterYaml and allows easy language file reading with support for multiple, localised default contents It also introduces a getMessages() method that returns a Map, linking message path to message

BetterLang(String, ValidationHandler, JavaPlugin) - Constructor for class be.dezijwegel.betteryaml.BetterLang

Easily manage localised language files The language template must be located in the /templates folder Any default language contents must be located in the /lang folder Logging is disabled

BetterLang(String, String, ValidationHandler, JavaPlugin) - Constructor for class be.dezijwegel.betteryaml.BetterLang

Easily manage localised language files The language template must be located in the /templates folder Any default language contents must be located in the /lang folder Logging is disabled

BetterLang(String, String, ValidationHandler, JavaPlugin, boolean) - Constructor for class be.dezijwegel.betteryaml.BetterLang

Easily manage localised language files The language template must be located in the /templates folder Any default language contents must be located in the /lang folder

BetterLang(String, String, JavaPlugin) - Constructor for class be.dezijwegel.betteryaml.BetterLang

Easily manage localised language files The language template must be located in the /templates folder Any default language contents must be located in the /lang folder Logging is disabled

BetterLang(String, String, JavaPlugin, boolean) - Constructor for class be.dezijwegel.betteryaml.BetterLang

Easily manage localised language files The language template must be located in the /templates folder Any default language contents must be located in the /lang folder

BetterLang(String, JavaPlugin) - Constructor for class be.dezijwegel.betteryaml.BetterLang

Easily manage localised language files The language template must be located in the /templates folder Any default language contents must be located in the /lang folder Logging is disabled

BetterYaml - Class in be.dezijwegel.betteryaml

A class aimed at internal use only.

BetterYaml(String, ValidationHandler, JavaPlugin, boolean) - Constructor for class be.dezijwegel.betteryaml.BetterYaml

Deprecated.

We advise using OptionalBetterYaml, this causes less clutter in your code. However, this class will not be removed in future versions as some people may want to handle exceptions themselves.

BetterYaml(String, String, String, ValidationHandler, JavaPlugin, boolean) - Constructor for class be.dezijwegel.betteryaml.BetterYaml

Deprecated.

We advise against using this constructor as it is meant for internal use only. This constructor enables you to alter the desired path structure, so only use it when you know what you are doing!

BetterYaml(String, String, String, JavaPlugin, boolean) - Constructor for class be.dezijwegel.betteryaml.BetterYaml

Deprecated.

We advise against using this constructor as it is meant for internal use only. This constructor enables you to alter the desired path structure, so only use it when you know what you are doing!

BetterYaml(String, JavaPlugin) - Constructor for class be.dezijwegel.betteryaml.BetterYaml

Deprecated.

We advise using OptionalBetterYaml, this causes less clutter in your code. However, this class will not be removed in future versions as some people may want to handle exceptions themselves.

BetterYaml(String, JavaPlugin, boolean) - Constructor for class be.dezijwegel.betteryaml.BetterYaml

Deprecated.

We advise using OptionalBetterYaml, this causes less clutter in your code. However, this class will not be removed in future versions as some people may want to handle exceptions themselves.

C

ChainedValidator - Class in be.dezijwegel.betteryaml.validation.validator

ChainedValidator(Validator...) - Constructor for class be.dezijwegel.betteryaml.validation.validator.ChainedValidator

This allows multiple validators to be used on one field They are executed in the given order

classTags - Variable in class be.dezijwegel.betteryaml.representer.CustomRepresenter

compare(Number, Number) - Static method in class be.dezijwegel.betteryaml.util.NumbersUtil

Taken from https://stackoverflow.com/questions/12561485/how-to-compare-two-numbers-in-java

CustomFormatter - Class in be.dezijwegel.betteryaml.formatting

CustomFormatter() - Constructor for class be.dezijwegel.betteryaml.formatting.CustomFormatter

CustomRepresenter - Class in be.dezijwegel.betteryaml.representer

CustomRepresenter() - Constructor for class be.dezijwegel.betteryaml.representer.CustomRepresenter

Inspired by: https://stackoverflow.com/questions/60501519/missing-double-quotes-for-the-required-field-using-snake-yaml

D

deleteCopiedFile() - Method in class be.dezijwegel.betteryaml.files.TempFileCopier

Delete the copied file

F

format(Object, String) - Method in class be.dezijwegel.betteryaml.formatting.CustomFormatter

format(Object, String) - Method in interface be.dezijwegel.betteryaml.formatting.IFormatter

G

getContents() - Method in class be.dezijwegel.betteryaml.files.YamlReader

Get the contents from the provided File or InputStream ConfigurationSections are not added separately Nested keys are saved as: section.subsection.option

getFile() - Method in class be.dezijwegel.betteryaml.BetterLang

Get the loaded File.

getFile() - Method in class be.dezijwegel.betteryaml.BetterYaml

getFile() - Method in interface be.dezijwegel.betteryaml.interfaces.IConfigReader

getFile() - Method in interface be.dezijwegel.betteryaml.interfaces.IOptionalConfigReader

getFile() - Method in class be.dezijwegel.betteryaml.OptionalBetterYaml

Get the loaded File.

getMessages() - Method in class be.dezijwegel.betteryaml.BetterLang

Get all messages in this language file.

getTag(Class<?>, Tag) - Method in class be.dezijwegel.betteryaml.representer.CustomRepresenter

getTimeZone() - Method in class be.dezijwegel.betteryaml.representer.CustomRepresenter

getYamlConfiguration() - Method in class be.dezijwegel.betteryaml.BetterLang

Get the loaded YamlConfiguration.

getYamlConfiguration() - Method in class be.dezijwegel.betteryaml.BetterYaml

getYamlConfiguration() - Method in interface be.dezijwegel.betteryaml.interfaces.IConfigReader

getYamlConfiguration() - Method in interface be.dezijwegel.betteryaml.interfaces.IOptionalConfigReader

getYamlConfiguration() - Method in class be.dezijwegel.betteryaml.OptionalBetterYaml

Get the loaded YamlConfiguration.

I

IConfigReader - Interface in be.dezijwegel.betteryaml.interfaces

An interface for Config Reading

IFormatter - Interface in be.dezijwegel.betteryaml.formatting

IOptionalConfigReader - Interface in be.dezijwegel.betteryaml.interfaces

An improvement upon IConfigReader, where we now work with Optionals

M

Max - Class in be.dezijwegel.betteryaml.validation.validator.numeric

Max(Number) - Constructor for class be.dezijwegel.betteryaml.validation.validator.numeric.Max

Provide a maximum value for this setting This will be handled as a double internally Validate will return the max value for faulty types (non-numbers)

merge(Map<String, Object>) - Method in class be.dezijwegel.betteryaml.util.YamlMerger

Merge the given options with the stored defaults The provided options will get priority over default values Any missing values in the provided map will be filled in by the default values All keys in the provided map, that are not in the defaultOptions (provided through constructor), will be ignored

Min - Class in be.dezijwegel.betteryaml.validation.validator.numeric

Min(Number) - Constructor for class be.dezijwegel.betteryaml.validation.validator.numeric.Min

Provide a minimum value for this setting This will be handled as a double internally Validate will return the min value for faulty types (non-numbers)

N

nonPrintableStyle - Variable in class be.dezijwegel.betteryaml.representer.CustomRepresenter

NumbersUtil - Class in be.dezijwegel.betteryaml.util

NumbersUtil() - Constructor for class be.dezijwegel.betteryaml.util.NumbersUtil

O

onEnable() - Method in class be.dezijwegel.betteryaml.testplugin.TestPlugin

OptionalBetterYaml - Class in be.dezijwegel.betteryaml

A wrapper around BetterYaml, handling all Exceptions and working with Optional to show where errors have happened

OptionalBetterYaml(String, ValidationHandler, JavaPlugin) - Constructor for class be.dezijwegel.betteryaml.OptionalBetterYaml

Handles IOException internally for those who want to avoid handling try-catches A File and YamlConfiguration can later be retrieved as an Optional Creates a BetterYaml instance that will handle your config files For the server's file: Missing options will be autocompleted and comments will be updated based on the template No settings will be changed Will not log any messages to the console

OptionalBetterYaml(String, ValidationHandler, JavaPlugin, boolean) - Constructor for class be.dezijwegel.betteryaml.OptionalBetterYaml

Handles IOException internally for those who want to avoid handling try-catches A File and YamlConfiguration can later be retrieved as an Optional Creates a BetterYaml instance that will handle your config files For the server's file: Missing options will be autocompleted and comments will be updated based on the template No settings will be changed

OptionalBetterYaml(String, JavaPlugin) - Constructor for class be.dezijwegel.betteryaml.OptionalBetterYaml

Handles IOException internally for those who want to avoid handling try-catches A File and YamlConfiguration can later be retrieved as an Optional Creates a BetterYaml instance that will handle your config files For the server's file: Missing options will be autocompleted and comments will be updated based on the template No settings will be changed Will not log any messages to the console

OptionalBetterYaml(String, JavaPlugin, boolean) - Constructor for class be.dezijwegel.betteryaml.OptionalBetterYaml

Handles IOException internally for those who want to avoid handling try-catches A File and YamlConfiguration can later be retrieved as an Optional Creates a BetterYaml instance that will handle your config files For the server's file: Missing options will be autocompleted and comments will be updated based on the template No settings will be changed

R

Range - Class in be.dezijwegel.betteryaml.validation.validator.numeric

Range(Number, Number) - Constructor for class be.dezijwegel.betteryaml.validation.validator.numeric.Range

Provide a range [min, max] for this setting This will be handled as a double internally

S

setTimeZone(TimeZone) - Method in class be.dezijwegel.betteryaml.representer.CustomRepresenter

StringWhiteList - Class in be.dezijwegel.betteryaml.validation.validator.string

StringWhiteList(String, boolean, String...) - Constructor for class be.dezijwegel.betteryaml.validation.validator.string.StringWhiteList

Provide a list of strings that are allowed for this setting and a default value The object is maintained if it is an allowed value If the object is not allowed, the default value will be returned

T

TempFileCopier - Class in be.dezijwegel.betteryaml.files

TempFileCopier(Plugin, String, String, String) - Constructor for class be.dezijwegel.betteryaml.files.TempFileCopier

Copy the specified file to a relative location of the plugins config folder Provide an empty string if you want to copy to /plugins/YOURPLUGIN/fileName fileName will be equal to the one provided in the constructor

TestPlugin - Class in be.dezijwegel.betteryaml.testplugin

TestPlugin() - Constructor for class be.dezijwegel.betteryaml.testplugin.TestPlugin

timeZone - Variable in class be.dezijwegel.betteryaml.representer.CustomRepresenter

ToLowerCase - Class in be.dezijwegel.betteryaml.validation.validator.string

ToLowerCase() - Constructor for class be.dezijwegel.betteryaml.validation.validator.string.ToLowerCase

Makes any validated input lowercase Any non-String will be converted to an empty String

V

validate(Object) - Method in class be.dezijwegel.betteryaml.validation.validator.ChainedValidator

validate(Object) - Method in class be.dezijwegel.betteryaml.validation.validator.numeric.Max

validate(Object) - Method in class be.dezijwegel.betteryaml.validation.validator.numeric.Min

validate(Object) - Method in class be.dezijwegel.betteryaml.validation.validator.numeric.Range

validate(Object) - Method in class be.dezijwegel.betteryaml.validation.validator.string.StringWhiteList

validate(Object) - Method in class be.dezijwegel.betteryaml.validation.validator.string.ToLowerCase

validate(Object) - Method in class be.dezijwegel.betteryaml.validation.validator.Validator

validateConfiguration(Map<String, Object>) - Method in class be.dezijwegel.betteryaml.validation.ValidationHandler

ValidationHandler - Class in be.dezijwegel.betteryaml.validation

ValidationHandler() - Constructor for class be.dezijwegel.betteryaml.validation.ValidationHandler

Validator - Class in be.dezijwegel.betteryaml.validation.validator

Validator() - Constructor for class be.dezijwegel.betteryaml.validation.validator.Validator

Y

YamlMerger - Class in be.dezijwegel.betteryaml.util

YamlMerger(Map<String, Object>) - Constructor for class be.dezijwegel.betteryaml.util.YamlMerger

Prepare default options to be merged with live options

YamlReader - Class in be.dezijwegel.betteryaml.files

YamlReader(File) - Constructor for class be.dezijwegel.betteryaml.files.YamlReader

Creates a YamlReader from a given File YamlReader supports nested keys All key-value pairs will be added to a Map

YamlReader(InputStream) - Constructor for class be.dezijwegel.betteryaml.files.YamlReader

Creates a YamlReader from a given InputStream YamlReader supports nested keys All key-value pairs will be added to a Map

A B C D F G I M N O R S T V Y
All Classes|All Packages