Index

A B C D E F G H I K L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

add(int, String) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

add(int, String, boolean) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

add(String) - Method in class org.simpleyaml.configuration.comments.KeyTree

Get a child from its path.

add(String) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

add(String, boolean) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

add(String, boolean) - Method in class org.simpleyaml.configuration.comments.YamlKeyTree.YamlCommentNode

addClassTag(Class<? extends Object>, Tag) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter

addComment(String) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

addDefault(Object) - Method in class org.simpleyaml.configuration.ConfigurationWrapper

Sets the default value of this path.

addDefault(Object) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

addDefault(String, Object) - Method in interface org.simpleyaml.configuration.Configuration

Sets the default value of the given path as provided.

addDefault(String, Object) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Sets the default value in the root at the given path as provided.

addDefault(String, Object) - Method in class org.simpleyaml.configuration.ConfigurationWrapper

Sets the default value of the provided child path.

addDefault(String, Object) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

addDefault(String, Object) - Method in class org.simpleyaml.configuration.MemoryConfiguration

addDefault(String, Object) - Method in class org.simpleyaml.configuration.MemorySection

addDefaults(Map<String, Object>) - Method in interface org.simpleyaml.configuration.Configuration

Sets the default values of the given paths as provided.

addDefaults(Map<String, Object>) - Method in class org.simpleyaml.configuration.MemoryConfiguration

addDefaults(Configuration) - Method in interface org.simpleyaml.configuration.Configuration

Sets the default values of the given paths as provided.

addDefaults(Configuration) - Method in class org.simpleyaml.configuration.MemoryConfiguration

addKey(String, boolean) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

AFTER_KEY - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage

afterNewLine(String) - Static method in class org.simpleyaml.utils.StringUtils

allElementsOfType(Collection<?>, Class<?>) - Static method in class org.simpleyaml.utils.Validate

Validate an argument, throwing IllegalArgumentException if the argument collection is null or has elements that are not of type clazz or a subclass.

allElementsOfType(Collection<?>, Class<?>, String) - Static method in class org.simpleyaml.utils.Validate

Validate an argument, throwing IllegalArgumentException if the argument collection is null or has elements that are not of type clazz or a subclass.

allLinesArePrefixed(String, String) - Static method in class org.simpleyaml.utils.StringUtils

allLinesArePrefixedOrBlank(String, String) - Static method in class org.simpleyaml.utils.StringUtils

appendBlockComment() - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

appendBlockComment(String) - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

appendCommentLine() - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

appendLine() - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

appendLine(StringBuilder, String, CommentLine, boolean) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

appendSideComment() - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

appendSideCommentLiteral(String) - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

apply(String) - Method in interface org.simpleyaml.configuration.ConfigurationWrapper.ApplyToPath

apply(ConfigurationWrapper.ApplyToPath) - Method in class org.simpleyaml.configuration.ConfigurationWrapper

applyToChild(ConfigurationWrapper.ApplyToPath, String) - Method in class org.simpleyaml.configuration.ConfigurationWrapper

await() - Method in class org.simpleyaml.utils.DumperBus

Consume the queue, blocking and awaiting a new line if the queue is empty.

B

beginExplicit - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

BLANK_LINE - Enum constant in enum org.simpleyaml.configuration.comments.format.YamlCommentFormat

BLANK_LINE comment format gets comments in a readable way stripping the # comment prefix and without indentation, but it keeps trailing spaces and blank lines.

BLANK_LINE - Static variable in class org.simpleyaml.utils.StringUtils

blankLine() - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

Set a blank line at the beginning of the block comment.

BlankLineYamlCommentFormatter - Class in org.simpleyaml.configuration.comments.format

YamlCommentFormat.BLANK_LINE formatter

BlankLineYamlCommentFormatter() - Constructor for class org.simpleyaml.configuration.comments.format.BlankLineYamlCommentFormatter

BlankLineYamlCommentFormatter(YamlCommentFormatterConfiguration) - Constructor for class org.simpleyaml.configuration.comments.format.BlankLineYamlCommentFormatter

BlankLineYamlCommentFormatter(YamlCommentFormatterConfiguration, YamlSideCommentFormatterConfiguration) - Constructor for class org.simpleyaml.configuration.comments.format.BlankLineYamlCommentFormatter

BLOCK - Enum constant in enum org.simpleyaml.configuration.comments.CommentType

blockComment - Variable in class org.simpleyaml.configuration.comments.YamlCommentParser

blockCommentStarted - Variable in class org.simpleyaml.configuration.comments.YamlCommentParser

blockFormatter - Variable in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

blockFormatter() - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

buildHeader() - Method in class org.simpleyaml.configuration.file.FileConfiguration

Compiles the header for this FileConfiguration and returns the result.

bus - Variable in class org.simpleyaml.configuration.comments.YamlCommentDumper

C

canBeChar(Object) - Static method in class org.simpleyaml.utils.CharacterConversions

canStartComment() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

canStartSpecialIndent(int) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

ceil(double) - Static method in class org.simpleyaml.utils.NumberConversions

CharacterConversions - Class in org.simpleyaml.utils

CharacterConversions() - Constructor for class org.simpleyaml.utils.CharacterConversions

charset() - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

charset(Charset) - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

charset(Charset) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

checkCommentPrefix(String) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

checkCommentPrefix(String) - Method in class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

checkCommentPrefixMultiline(String) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

checkCommentPrefixMultiline(String) - Method in class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

checkCommentSuffix(String) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

checkCommentSuffixMultiline(String) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

checkFirstListMapElement(KeyTree.Node, KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

checkList() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

checkSpecialChars() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

checkSpecialLines(boolean, int) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

childPath(String) - Method in class org.simpleyaml.configuration.ConfigurationWrapper

children - Variable in class org.simpleyaml.configuration.comments.KeyTree.Node

children() - Method in class org.simpleyaml.configuration.comments.KeyTree

children() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

classTags - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter

clear() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

clearCurrentNode() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

clearCurrentNodeIfNoComments() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

clearCurrentNodeIfNoComments() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

clearIf(Predicate<KeyTree.Node>) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

clearIf(Predicate<KeyTree.Node>, boolean) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

clearNode() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

clearNode(KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

clearNodeIfNoComments(KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

clearSection() - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

close() - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

close() - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

close() - Method in class org.simpleyaml.utils.DumperBus

Called after dumping all the values.

comment - Variable in class org.simpleyaml.configuration.comments.KeyTree.Node

comment(String) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

Set a block comment above the section or value selected by path.

comment(String, YamlCommentFormat) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

Set a block comment to the section or value selected by path.

comment(String, YamlCommentFormatter) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

Set a block comment to the section or value selected by path.

COMMENT - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage

COMMENT_INDICATOR - Static variable in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

Commentable - Interface in org.simpleyaml.configuration.comments

commentFormatter() - Method in enum org.simpleyaml.configuration.comments.format.YamlCommentFormat

commentFormatter() - Method in interface org.simpleyaml.configuration.comments.format.YamlCommentFormat.YamlCommentFormatterFactory

commentFormatter() - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

Gets the comment formatter used to format comments.

commentFormatter(YamlCommentFormatter) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

Sets the comment formatter to be used to format comments.

CommentFormatter - Interface in org.simpleyaml.configuration.comments.format

Converts a comment between a raw-format meant to be read by computers to a human-format meant to be read by humans and vice versa.

CommentFormatterConfiguration - Class in org.simpleyaml.configuration.comments.format

CommentFormatterConfiguration() - Constructor for class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

commentNode - Variable in class org.simpleyaml.configuration.comments.YamlCommentDumper

commentNodeFallback - Variable in class org.simpleyaml.configuration.comments.YamlCommentDumper

commentPrefix() - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

Gets the comment prefix to apply to every line of the header.

commentPrefix(String) - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

Sets the comment prefix to apply to every line of the header.

commentSide(String) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

Set a side comment above the section or value selected by path.

commentSide(String, YamlCommentFormat) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

Set a side comment to the section or value selected by path.

commentSide(String, YamlCommentFormatter) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

Set a side comment to the section or value selected by path.

commentSuffix(String) - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

Set the comment suffix to append to every line of the header.

CommentType - Enum in org.simpleyaml.configuration.comments

configuration - Variable in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

configuration - Variable in class org.simpleyaml.configuration.ConfigurationWrapper

configuration() - Method in class org.simpleyaml.configuration.ConfigurationOptions

Returns the Configuration that this object is responsible for.

configuration() - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

configuration() - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

configuration() - Method in class org.simpleyaml.configuration.MemoryConfigurationOptions

Configuration - Interface in org.simpleyaml.configuration

Represents a source of configurable options and settings

ConfigurationOptions - Class in org.simpleyaml.configuration

Various settings for controlling the input and output of a Configuration

ConfigurationOptions(Configuration) - Constructor for class org.simpleyaml.configuration.ConfigurationOptions

ConfigurationSection - Interface in org.simpleyaml.configuration

Represents a section of a Configuration

ConfigurationSerializable - Interface in org.simpleyaml.configuration.serialization

Represents an object that may be serialized.

ConfigurationSerialization - Class in org.simpleyaml.configuration.serialization

Utility class for storing and retrieving classes for Configuration.

ConfigurationSerialization(Class<? extends ConfigurationSerializable>) - Constructor for class org.simpleyaml.configuration.serialization.ConfigurationSerialization

ConfigurationWrapper<T extends Configuration> - Class in org.simpleyaml.configuration

ConfigurationWrapper(T, String) - Constructor for class org.simpleyaml.configuration.ConfigurationWrapper

ConfigurationWrapper(T, String, ConfigurationWrapper<T>) - Constructor for class org.simpleyaml.configuration.ConfigurationWrapper

ConfigurationWrapper.ApplyToPath - Interface in org.simpleyaml.configuration

ConfigurationWrapper.SetToPath - Interface in org.simpleyaml.configuration

configure(YamlConfigurationOptions) - Method in interface org.simpleyaml.configuration.implementation.api.YamlImplementation

Apply the configuration options to this implementation.

configure(YamlConfigurationOptions) - Method in class org.simpleyaml.configuration.implementation.api.YamlImplementationCommentable

configure(YamlConfigurationOptions) - Method in class org.simpleyaml.configuration.implementation.SimpleYamlImplementation

configure(YamlConfigurationOptions) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

construct(Node) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlConstructor

contains(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if this ConfigurationSection contains the given path.

contains(String) - Method in class org.simpleyaml.configuration.MemorySection

convertMapsToSections(Map<?, ?>, ConfigurationSection) - Static method in class org.simpleyaml.utils.SectionUtils

copyDefaults() - Method in class org.simpleyaml.configuration.ConfigurationOptions

Checks if the Configuration should copy values from its default Configuration directly.

copyDefaults(boolean) - Method in class org.simpleyaml.configuration.ConfigurationOptions

Sets if the Configuration should copy values from its default Configuration directly.

copyDefaults(boolean) - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

copyDefaults(boolean) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

copyDefaults(boolean) - Method in class org.simpleyaml.configuration.MemoryConfigurationOptions

copyHeader() - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

Gets whether or not the header should be copied from a default source.

copyHeader(boolean) - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

Sets whether or not the header should be copied from a default source.

copyHeader(boolean) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

copyTo(File) - Method in class org.simpleyaml.configuration.file.YamlFile

Copy this configuration file to another file, without deleting configuration file.

copyTo(String) - Method in class org.simpleyaml.configuration.file.YamlFile

Copy this configuration file to another path, without deleting configuration file.

createNewFile() - Method in class org.simpleyaml.configuration.file.YamlFile

Creates a new empty file atomically for this configuration file if and only if it does not already exist.

createNewFile(boolean) - Method in class org.simpleyaml.configuration.file.YamlFile

Creates a new empty file atomically for this configuration file.

createNode(KeyTree.Node, int, String) - Method in class org.simpleyaml.configuration.comments.KeyTree

createNode(KeyTree.Node, int, String) - Method in class org.simpleyaml.configuration.comments.YamlKeyTree

createOrLoad() - Method in class org.simpleyaml.configuration.file.YamlFile

If this configuration file does not exist then it is created along with missing parent directories.

createOrLoadWithComments() - Method in class org.simpleyaml.configuration.file.YamlFile

If this configuration file does not exist then it is created along with missing parent directories.

createPath(ConfigurationSection, String) - Static method in class org.simpleyaml.configuration.MemorySection

Creates a full path to the given ConfigurationSection from its root Configuration.

createPath(ConfigurationSection, String, ConfigurationSection) - Static method in class org.simpleyaml.configuration.MemorySection

Creates a relative path to the given ConfigurationSection from the given relative section.

createSection() - Method in class org.simpleyaml.configuration.ConfigurationWrapper

Creates an empty ConfigurationSection at this path.

createSection() - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

createSection(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Creates an empty ConfigurationSection at the specified path.

createSection(String) - Method in class org.simpleyaml.configuration.ConfigurationWrapper

Creates an empty ConfigurationSection at the provided child path.

createSection(String) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

createSection(String) - Method in class org.simpleyaml.configuration.MemorySection

createSection(String, Map<?, ?>) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Creates a ConfigurationSection at the specified path, with specified values.

createSection(String, Map<?, ?>) - Method in class org.simpleyaml.configuration.MemorySection

currentChar - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

currentLine - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

currentList - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

currentNode - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

currentNode - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

D

DEFAULT - Enum constant in enum org.simpleyaml.configuration.comments.format.YamlCommentFormat

DEFAULT comment format gets comments in a readable way stripping the # comment prefix, without leading and trailing spaces or blank lines and without indentation.

DEFAULT_COMMENT_PREFIX - Static variable in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

DEFAULT_SIDE_COMMENT_PREFIX - Static variable in class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

defaults - Variable in class org.simpleyaml.configuration.MemoryConfiguration

DelegateDeserialization - Annotation Type in org.simpleyaml.configuration.serialization

Applies to a ConfigurationSerializable that will delegate all deserialization to another ConfigurationSerializable.

deleteFile() - Method in class org.simpleyaml.configuration.file.YamlFile

Deletes this configuration file from disk.

deserialize(Map<String, ?>) - Method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

deserializeObject(Map<String, ?>) - Static method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

Attempts to deserialize the given arguments into a new instance of the given class.

deserializeObject(Map<String, ?>, Class<? extends ConfigurationSerializable>) - Static method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

Attempts to deserialize the given arguments into a new instance of the given class.

deserializeViaCtor(Constructor<? extends ConfigurationSerializable>, Map<String, ?>) - Method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

deserializeViaMethod(Method, Map<String, ?>) - Method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

DOUBLE - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReadingQuoteStyle

DOUBLE - Enum constant in enum org.simpleyaml.configuration.implementation.api.QuoteStyle

Wrap values with double quotes.

dump() - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

Merge comments from the comment mapper with lines from the source.

dump() - Method in class org.simpleyaml.configuration.file.YamlConfiguration

Dump the configuration values without the header to a string.

dump() - Method in class org.simpleyaml.utils.DumperBus

Dump source values into this writer in a background thread.

dump(Writer) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

Dump the configuration values without the header.

dump(Writer) - Method in interface org.simpleyaml.utils.DumperBus.Dumper

dump(Writer, ConfigurationSection) - Method in interface org.simpleyaml.configuration.implementation.api.YamlImplementation

Dump section values to Yaml.

dump(Writer, ConfigurationSection) - Method in class org.simpleyaml.configuration.implementation.SimpleYamlImplementation

dump(Writer, ConfigurationSection) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

dump(String) - Method in interface org.simpleyaml.configuration.comments.format.CommentFormatter

dump(String, CommentType) - Method in interface org.simpleyaml.configuration.comments.format.CommentFormatter

dump(String, CommentType, KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.format.BlankLineYamlCommentFormatter

dump(String, CommentType, KeyTree.Node) - Method in interface org.simpleyaml.configuration.comments.format.CommentFormatter

Given a comment returns the raw-formatted string to be dumped somewhere like a file.

dump(String, CommentType, KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.format.PrettyYamlCommentFormatter

dump(String, CommentType, KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

dump(String, CommentType, KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

Given the header (for instance the one returned by YamlHeaderFormatter.parse(java.lang.String, org.simpleyaml.configuration.comments.CommentType, org.simpleyaml.configuration.comments.KeyTree.Node)), returns the final string formatted to be dumped somewhere like a file.

dump(ConfigurationSection) - Method in interface org.simpleyaml.configuration.implementation.api.YamlImplementation

Dump section values to a Yaml string.

DumperBus - Class in org.simpleyaml.utils

Every line written to this writer will be enqueued on flush with a fixed capacity.

DumperBus(DumperBus.Dumper) - Constructor for class org.simpleyaml.utils.DumperBus

DumperBus(DumperBus.Dumper, int) - Constructor for class org.simpleyaml.utils.DumperBus

DumperBus.Dumper - Interface in org.simpleyaml.utils

Source for dumping values to this writer.

dumperOptions - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

dumpYaml(Writer, ConfigurationSection) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

E

elementIndex - Variable in class org.simpleyaml.configuration.comments.KeyTree.Node

END_OF_FILE - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage

END_OF_LINE - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage

endExplicitBlock() - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

endExplicitBlock() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

endExplicitNotation() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

entries() - Method in class org.simpleyaml.configuration.comments.KeyTree

entries() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

equals(Object) - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

equals(Object) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

equals(Object) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

equals(Object) - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

equals(Object) - Method in class org.simpleyaml.configuration.ConfigurationOptions

equals(Object) - Method in class org.simpleyaml.configuration.ConfigurationWrapper

equals(Object) - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

equals(Object) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

equals(Object) - Method in class org.simpleyaml.configuration.implementation.api.QuoteValue

escape(String) - Static method in class org.simpleyaml.utils.StringUtils

ESCAPE_CHAR - Static variable in class org.simpleyaml.utils.StringUtils

exists() - Method in class org.simpleyaml.configuration.file.YamlFile

Tests whether this configuration file exists.

explicitBlock - Variable in class org.simpleyaml.configuration.comments.YamlCommentDumper

explicitNotation - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

F

FileConfiguration - Class in org.simpleyaml.configuration.file

This is a base class for all File based implementations of Configuration

FileConfiguration() - Constructor for class org.simpleyaml.configuration.file.FileConfiguration

Creates an empty FileConfiguration with no default values.

FileConfiguration(Configuration) - Constructor for class org.simpleyaml.configuration.file.FileConfiguration

Creates an empty FileConfiguration using the specified Configuration as a source for all default values.

FileConfigurationOptions - Class in org.simpleyaml.configuration.file

Various settings for controlling the input and output of a FileConfiguration

FileConfigurationOptions(MemoryConfiguration) - Constructor for class org.simpleyaml.configuration.file.FileConfigurationOptions

fileToString() - Method in class org.simpleyaml.configuration.file.YamlFile

Returns a representation of the already saved configuration file.

findParent(int) - Method in class org.simpleyaml.configuration.comments.KeyTree

Get the last node that can be a parent of a child with the indent provided.

findParent(KeyTree.Node, int) - Method in class org.simpleyaml.configuration.comments.KeyTree

finish() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

firstListMapElement - Variable in class org.simpleyaml.configuration.comments.YamlCommentDumper

firstSeparatorIndex(String, char) - Static method in class org.simpleyaml.utils.StringUtils

firstSeparatorIndex(String, char, int) - Static method in class org.simpleyaml.utils.StringUtils

flattenMapping(MappingNode) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlConstructor

floor(double) - Static method in class org.simpleyaml.utils.NumberConversions

flush() - Method in class org.simpleyaml.utils.DumperBus

Append the current characters to the queue as a new line and reset the current line buffer.

FOLDED - Enum constant in enum org.simpleyaml.configuration.implementation.api.QuoteStyle

folded: >- Each line is literal and are joined with spaces

format(int, String, String, String, CommentType, String, String) - Static method in interface org.simpleyaml.configuration.comments.format.CommentFormatter

format(int, String, CommentType, CommentFormatterConfiguration) - Static method in interface org.simpleyaml.configuration.comments.format.CommentFormatter

format(String, String, String, String, String) - Static method in interface org.simpleyaml.configuration.comments.format.CommentFormatter

formatterConfiguration(CommentType) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

G

get() - Method in interface org.simpleyaml.utils.SupplierIO

get(int) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

Get a child from its index.

get(String) - Method in class org.simpleyaml.configuration.comments.KeyTree

Get a child from its path.

get(String) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

Get a child from its path.

get(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested Object by path.

get(String) - Method in class org.simpleyaml.configuration.MemorySection

get(String, boolean, boolean) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

Get a child from its path, or optionally add a new one if it is not created.

get(String, Object) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested Object by path, returning a default value if not found.

get(String, Object) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

get(String, Object) - Method in class org.simpleyaml.configuration.MemorySection

getAlias(Class<? extends ConfigurationSerializable>) - Static method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

Gets the correct alias for the given ConfigurationSerializable class

getBoolean(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested boolean by path.

getBoolean(String) - Method in class org.simpleyaml.configuration.MemorySection

getBoolean(String, boolean) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested boolean by path, returning a default value if not found.

getBoolean(String, boolean) - Method in class org.simpleyaml.configuration.MemorySection

getBooleanList(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested List of Boolean by path.

getBooleanList(String) - Method in class org.simpleyaml.configuration.MemorySection

getByte(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested byte by path.

getByte(String) - Method in class org.simpleyaml.configuration.MemorySection

getByte(String, byte) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested byte by path, returning a default value if not found.

getByte(String, byte) - Method in class org.simpleyaml.configuration.MemorySection

getByteList(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested List of Byte by path.

getByteList(String) - Method in class org.simpleyaml.configuration.MemorySection

getChar() - Method in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReadingQuoteStyle

getCharacter(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested char by path.

getCharacter(String) - Method in class org.simpleyaml.configuration.MemorySection

getCharacter(String, char) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested char by path, returning a default value if not found.

getCharacter(String, char) - Method in class org.simpleyaml.configuration.MemorySection

getCharacterList(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested List of Character by path.

getCharacterList(String) - Method in class org.simpleyaml.configuration.MemorySection

getClassByAlias(String) - Static method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

Attempts to get a registered ConfigurationSerializable class by its alias

getComment() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

getComment(String) - Method in interface org.simpleyaml.configuration.comments.Commentable

Retrieve the block comment of the section or value selected by path.

getComment(String) - Method in class org.simpleyaml.configuration.file.YamlFile

Retrieve the block comment of the section or value selected by path.

getComment(String, CommentType) - Method in interface org.simpleyaml.configuration.comments.Commentable

Retrieve the comment of the section or value selected by path.

getComment(String, CommentType) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

getComment(String, CommentType) - Method in class org.simpleyaml.configuration.file.YamlFile

Retrieve the comment of the section or value selected by path.

getComment(String, CommentType) - Method in class org.simpleyaml.configuration.implementation.api.YamlImplementationCommentable

getComment(String, CommentType, YamlCommentFormat) - Method in class org.simpleyaml.configuration.file.YamlFile

Retrieve the comment of the section or value selected by path.

getComment(String, CommentType, YamlCommentFormatter) - Method in class org.simpleyaml.configuration.file.YamlFile

Retrieve the comment of the section or value selected by path.

getComment(String, YamlCommentFormat) - Method in class org.simpleyaml.configuration.file.YamlFile

Retrieve the block comment of the section or value selected by path.

getComment(String, YamlCommentFormatter) - Method in class org.simpleyaml.configuration.file.YamlFile

Retrieve the block comment of the section or value selected by path.

getComment(List<CommentLine>, String, String) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

getComment(KeyTree.Node, CommentType) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

getCommentLines(String, CommentType) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

getCommentMapper() - Method in class org.simpleyaml.configuration.file.YamlFile

Get the comment mapper.

getCommentMapper() - Method in class org.simpleyaml.configuration.implementation.api.YamlImplementationCommentable

Get the comment mapper to get or set comments.

getCommentNode(KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

getConfigurationFile() - Method in class org.simpleyaml.configuration.file.YamlFile

Returns this configuration file where data is located.

getConfigurationSection(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested ConfigurationSection by path.

getConfigurationSection(String) - Method in class org.simpleyaml.configuration.MemorySection

getConstructor() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

getConstructor() - Method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

getCurrentPath() - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the path of this ConfigurationSection from its root Configuration

getCurrentPath() - Method in class org.simpleyaml.configuration.ConfigurationWrapper

Gets the current path.

getCurrentPath() - Method in class org.simpleyaml.configuration.MemorySection

getDefault(String) - Method in class org.simpleyaml.configuration.MemorySection

getDefaultQuoteStyle() - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions.QuoteStyleDefaults

Get the default quote style.

getDefaults() - Method in interface org.simpleyaml.configuration.Configuration

Gets the source Configuration for this configuration.

getDefaults() - Method in class org.simpleyaml.configuration.MemoryConfiguration

getDefaultSection() - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the equivalent ConfigurationSection from the default Configuration defined in ConfigurationSection.getRoot().

getDefaultSection() - Method in class org.simpleyaml.configuration.MemorySection

getDouble(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested double by path.

getDouble(String) - Method in class org.simpleyaml.configuration.MemorySection

getDouble(String, double) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested double by path, returning a default value if not found.

getDouble(String, double) - Method in class org.simpleyaml.configuration.MemorySection

getDoubleList(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested List of Double by path.

getDoubleList(String) - Method in class org.simpleyaml.configuration.MemorySection

getDumperOptions() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

getDumperOptions() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter

getElement(int) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

Get a child list element from its index.

getElement(int, boolean) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

Get a child list element from its index, or optionally add a new one if it is not created.

getElementIndex() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

getFilePath() - Method in class org.simpleyaml.configuration.file.YamlFile

Returns the absolute pathname string of this configuration file.

getFirst() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

getFloat(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested float by path.

getFloat(String) - Method in class org.simpleyaml.configuration.MemorySection

getFloat(String, float) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested float by path, returning a default value if not found.

getFloat(String, float) - Method in class org.simpleyaml.configuration.MemorySection

getFloatList(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested List of Float by path.

getFloatList(String) - Method in class org.simpleyaml.configuration.MemorySection

getFooter() - Method in class org.simpleyaml.configuration.file.YamlFile

Gets the footer of this configuration file.

getHeader() - Method in class org.simpleyaml.configuration.file.YamlFile

Gets the header of this configuration file.

getImplementation() - Method in class org.simpleyaml.configuration.file.YamlConfiguration

getIndentation() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

getIndentation() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

getInt(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested int by path.

getInt(String) - Method in class org.simpleyaml.configuration.MemorySection

getInt(String, int) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested int by path, returning a default value if not found.

getInt(String, int) - Method in class org.simpleyaml.configuration.MemorySection

getIntegerList(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested List of Integer by path.

getIntegerList(String) - Method in class org.simpleyaml.configuration.MemorySection

getKey() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

getKeyComment() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

getKeys(boolean) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets a set containing all keys in this section.

getKeys(boolean) - Method in class org.simpleyaml.configuration.MemorySection

getKeyTree() - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

getLast() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

getList(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested List by path.

getList(String) - Method in class org.simpleyaml.configuration.MemorySection

getList(String, List<?>) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested List by path, returning a default value if not found.

getList(String, List<?>) - Method in class org.simpleyaml.configuration.MemorySection

getListSize() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

getLoaderOptions() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

getLong(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested long by path.

getLong(String) - Method in class org.simpleyaml.configuration.MemorySection

getLong(String, long) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested long by path, returning a default value if not found.

getLong(String, long) - Method in class org.simpleyaml.configuration.MemorySection

getLongList(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested List of Long by path.

getLongList(String) - Method in class org.simpleyaml.configuration.MemorySection

getMapList(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested List of Maps by path.

getMapList(String) - Method in class org.simpleyaml.configuration.MemorySection

getMapValues(boolean) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets a Map containing all keys and their values for this section.

getMapValues(boolean) - Method in class org.simpleyaml.configuration.MemorySection

getMethod(String, boolean) - Method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

getName() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

getName() - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the name of this individual ConfigurationSection, in the path.

getName() - Method in class org.simpleyaml.configuration.MemorySection

getName(Node, boolean) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

getNode() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

getNode(String) - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

getNode(String) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

getOrAdd(String) - Method in class org.simpleyaml.configuration.comments.KeyTree

Get a child from its path.

getOrAddNode(String) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

getParent() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

getParent() - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the parent ConfigurationSection that directly contains this ConfigurationSection.

getParent() - Method in class org.simpleyaml.configuration.MemoryConfiguration

getParent() - Method in class org.simpleyaml.configuration.MemorySection

getPath() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

getPathWithName() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

getPriority(String) - Method in class org.simpleyaml.configuration.comments.KeyTree

Get a child from its path.

getPriority(String) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

Get a child from its path.

getPriorityNode(String) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

getPriorityNode(String) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

getQuoteScalarStyle(QuoteStyle) - Static method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlQuoteValue

getQuoteStyle() - Method in class org.simpleyaml.configuration.implementation.api.QuoteValue

getQuoteStyle(Class<?>) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions.QuoteStyleDefaults

Get the quote style to apply to a specific type.

getQuoteStyles() - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions.QuoteStyleDefaults

Get the overriden quote styles for every specific type set.

getRawComment(String, CommentType) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

getRawComment(KeyTree.Node, CommentType) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

getRepresenter() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

getResolver() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

getRoot() - Method in class org.simpleyaml.configuration.comments.KeyTree

Get the root node.

getRoot() - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the root Configuration that contains this ConfigurationSection

getRoot() - Method in class org.simpleyaml.configuration.MemorySection

getShort(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested short by path.

getShort(String) - Method in class org.simpleyaml.configuration.MemorySection

getShort(String, short) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested short by path, returning a default value if not found.

getShort(String, short) - Method in class org.simpleyaml.configuration.MemorySection

getShortList(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested List of Short by path.

getShortList(String) - Method in class org.simpleyaml.configuration.MemorySection

getSideComment() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

getSideCommentNode(Node, Node) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

getSize() - Method in class org.simpleyaml.configuration.file.YamlFile

Returns the size of this configuration file.

getStep() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

getString(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested String by path.

getString(String) - Method in class org.simpleyaml.configuration.MemorySection

getString(String, String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested String by path, returning a default value if not found.

getString(String, String) - Method in class org.simpleyaml.configuration.MemorySection

getStringList(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the requested List of String by path.

getStringList(String) - Method in class org.simpleyaml.configuration.MemorySection

getTag(Class<?>, Tag) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter

getTimeZone() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter

getValue() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

getValue() - Method in class org.simpleyaml.configuration.implementation.api.QuoteValue

getValueComment() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

getValues(boolean) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets a Map containing all keys and their values for this section.

getValues(boolean) - Method in class org.simpleyaml.configuration.MemorySection

getYaml() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

H

hasChar() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

hasChildren() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

hasContent(Writer, ConfigurationSection) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

hashCode() - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

hashCode() - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

hashCode() - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

hashCode() - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

hashCode() - Method in class org.simpleyaml.configuration.ConfigurationOptions

hashCode() - Method in class org.simpleyaml.configuration.ConfigurationWrapper

hashCode() - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

hashCode() - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

hashCode() - Method in class org.simpleyaml.configuration.implementation.api.QuoteValue

hasKey() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

hasNext() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

hasSerializedTypeKey(MappingNode) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlConstructor

header() - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

Gets the header that will be applied to the top of the saved output.

header(String) - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

Sets the header that will be applied to the top of the saved output.

header(String) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

headerFormatter() - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

Gets the header format used for parsing and dumping the header.

headerFormatter() - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

headerFormatter(CommentFormatter) - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

Sets the header format used for parsing and dumping the header.

headerFormatter(CommentFormatter) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

headerParsed - Variable in class org.simpleyaml.configuration.comments.YamlCommentParser

headerParsed - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

I

indent - Variable in class org.simpleyaml.configuration.comments.KeyTree.Node

indent - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

indent() - Method in class org.simpleyaml.configuration.ConfigurationOptions

Gets how much spaces should be used to indent each line.

indent(int) - Method in class org.simpleyaml.configuration.ConfigurationOptions

Sets how much spaces should be used to indent each line.

indent(int) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

Sets how much spaces should be used to indent each line.

indentation(int) - Static method in class org.simpleyaml.utils.StringUtils

INDENTATION - Static variable in class org.simpleyaml.utils.StringUtils

indentList() - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

Gets how much spaces should be used to indent each list element, in addition to the line indent.

indentList(int) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

Sets how much spaces should be used to indent each list element, in addition to the line indent.

indexByElementIndex - Variable in class org.simpleyaml.configuration.comments.KeyTree.Node

indexByName - Variable in class org.simpleyaml.configuration.comments.KeyTree.Node

inQuote(YamlCommentReader.ReadingQuoteStyle) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

InvalidConfigurationException - Exception in org.simpleyaml.exceptions

Exception thrown when attempting to load an invalid Configuration

InvalidConfigurationException() - Constructor for exception org.simpleyaml.exceptions.InvalidConfigurationException

Creates a new instance of InvalidConfigurationException without a message or cause.

InvalidConfigurationException(String) - Constructor for exception org.simpleyaml.exceptions.InvalidConfigurationException

Constructs an instance of InvalidConfigurationException with the specified message.

InvalidConfigurationException(String, Throwable) - Constructor for exception org.simpleyaml.exceptions.InvalidConfigurationException

Constructs an instance of InvalidConfigurationException with the specified message and cause.

InvalidConfigurationException(Throwable) - Constructor for exception org.simpleyaml.exceptions.InvalidConfigurationException

Constructs an instance of InvalidConfigurationException with the specified cause.

isBlank() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

isBoolean(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if the specified path is a boolean.

isBoolean(String) - Method in class org.simpleyaml.configuration.MemorySection

isByte(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if the specified path is a byte.

isByte(String) - Method in class org.simpleyaml.configuration.MemorySection

isCharacter(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if the specified path is a char.

isCharacter(String) - Method in class org.simpleyaml.configuration.MemorySection

isClosed() - Method in class org.simpleyaml.utils.DumperBus

isComment() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

isConfigurationSection(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if the specified path is a ConfigurationSection.

isConfigurationSection(String) - Method in class org.simpleyaml.configuration.MemorySection

isDouble(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if the specified path is a double.

isDouble(String) - Method in class org.simpleyaml.configuration.MemorySection

isEmpty() - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets if this configuration section is empty.

isEmpty() - Method in class org.simpleyaml.configuration.MemorySection

isEscaping - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

isExplicit() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

isExplicitChar() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

isFinished() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

isFirstNode() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

isFloat(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if the specified path is a float.

isFloat(String) - Method in class org.simpleyaml.configuration.MemorySection

isInQuote() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

isInt(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if the specified path is an int.

isInt(String) - Method in class org.simpleyaml.configuration.MemorySection

isKey() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

isList - Variable in class org.simpleyaml.configuration.comments.KeyTree.Node

isList() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

isList(int) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

isList(int) - Method in class org.simpleyaml.configuration.comments.YamlKeyTree.YamlCommentNode

isList(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if the specified path is a List.

isList(String) - Method in class org.simpleyaml.configuration.MemorySection

isListChar() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

isListElement - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

isLiteral - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

isLiteralChar() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

isLong(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if the specified path is a long.

isLong(String) - Method in class org.simpleyaml.configuration.MemorySection

isMultiline() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

isPrimitiveWrapper(Object) - Method in class org.simpleyaml.configuration.MemorySection

isRootNode() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

isSectionEnd() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

isSectionKey() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

isSet(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if this ConfigurationSection has a value set for the given path.

isSet(String) - Method in class org.simpleyaml.configuration.MemorySection

isShort(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if the specified path is a short.

isShort(String) - Method in class org.simpleyaml.configuration.MemorySection

isSpace(char) - Static method in class org.simpleyaml.configuration.comments.YamlCommentReader

isString(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Checks if the specified path is a String.

isString(String) - Method in class org.simpleyaml.configuration.MemorySection

isTrue(boolean) - Static method in class org.simpleyaml.utils.Validate

Validate that the argument condition is true; otherwise throwing an exception.

isTrue(boolean, String) - Static method in class org.simpleyaml.utils.Validate

Validate that the argument condition is true; otherwise throwing an exception with the specified message.

isTrue(boolean, String, double) - Static method in class org.simpleyaml.utils.Validate

Validate that the argument condition is true; otherwise throwing an exception with the specified message.

isTrue(boolean, String, long) - Static method in class org.simpleyaml.utils.Validate

Validate that the argument condition is true; otherwise throwing an exception with the specified message.

isTrue(boolean, String, Object) - Static method in class org.simpleyaml.utils.Validate

Validate that the argument condition is true; otherwise throwing an exception with the specified message.

isUnicode() - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

isValue() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

iterator() - Method in class org.simpleyaml.configuration.comments.KeyTree

iterator() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

K

key - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

KEY - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage

KEY - Static variable in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

keys() - Method in class org.simpleyaml.configuration.comments.KeyTree

keys() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

keyTree - Variable in class org.simpleyaml.configuration.comments.YamlCommentMapper

KeyTree - Class in org.simpleyaml.configuration.comments

KeyTree(ConfigurationOptions) - Constructor for class org.simpleyaml.configuration.comments.KeyTree

KeyTree.Node - Class in org.simpleyaml.configuration.comments

L

lastSeparatorIndex(String, char) - Static method in class org.simpleyaml.utils.StringUtils

lastSeparatorIndex(String, char, int) - Static method in class org.simpleyaml.utils.StringUtils

lines(String) - Static method in class org.simpleyaml.utils.StringUtils

lines(String, boolean) - Static method in class org.simpleyaml.utils.StringUtils

LIST_INDEX - Static variable in class org.simpleyaml.utils.StringUtils

listSize - Variable in class org.simpleyaml.configuration.comments.KeyTree.Node

LITERAL - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReadingQuoteStyle

LITERAL - Enum constant in enum org.simpleyaml.configuration.implementation.api.QuoteStyle

literal: |- Each line is literal and are joined with new lines

load() - Method in class org.simpleyaml.configuration.file.YamlFile

Loads configurations from this configuration file.

load(File) - Method in class org.simpleyaml.configuration.file.FileConfiguration

Loads this configuration from the specified file.

load(File) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

Loads this configuration from the specified file.

load(InputStream) - Method in class org.simpleyaml.configuration.file.FileConfiguration

Loads this configuration from the specified stream.

load(InputStream) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

Deprecated.

this method loads the entire file into memory, for larger files please use YamlConfiguration.load(SupplierIO.InputStream)

load(Reader) - Method in class org.simpleyaml.configuration.file.FileConfiguration

Loads this configuration from the specified reader.

load(Reader) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

Deprecated.

this method loads the entire file into memory, for larger files please use YamlConfiguration.load(SupplierIO.Reader)

load(Reader) - Method in interface org.simpleyaml.configuration.LoadableConfiguration

Loads this configuration from the specified reader.

load(Reader, ConfigurationSection) - Method in interface org.simpleyaml.configuration.implementation.api.YamlImplementation

Load Yaml to a configuration section.

load(Reader, ConfigurationSection) - Method in class org.simpleyaml.configuration.implementation.SimpleYamlImplementation

load(Reader, ConfigurationSection) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

load(String) - Method in class org.simpleyaml.configuration.file.FileConfiguration

Loads this configuration from the specified file path.

load(String, ConfigurationSection) - Method in interface org.simpleyaml.configuration.implementation.api.YamlImplementation

Load Yaml to a configuration section.

load(SupplierIO.InputStream) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

Loads this configuration from the specified stream.

load(SupplierIO.Reader) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

Loads this YamlConfiguration from the specified reader.

load(SupplierIO.Reader) - Method in class org.simpleyaml.configuration.file.YamlFile

Loads this YamlFile from the specified reader.

load(SupplierIO.Reader, ConfigurationSection) - Method in interface org.simpleyaml.configuration.implementation.api.YamlImplementation

Load Yaml to a configuration section.

load(SupplierIO.Reader, ConfigurationSection) - Method in class org.simpleyaml.configuration.implementation.SimpleYamlImplementation

LoadableConfiguration - Interface in org.simpleyaml.configuration

loadConfiguration(File) - Static method in class org.simpleyaml.configuration.file.YamlConfiguration

Creates a new YamlConfiguration, loading from the given file.

loadConfiguration(File) - Static method in class org.simpleyaml.configuration.file.YamlFile

Creates a new YamlFile, loading from the given file (without comments).

loadConfiguration(File, boolean) - Static method in class org.simpleyaml.configuration.file.YamlFile

Creates a new YamlFile, loading from the given file.

loadConfiguration(InputStream) - Static method in class org.simpleyaml.configuration.file.YamlConfiguration

Deprecated.

this method loads the entire file into memory, for larger files please use YamlConfiguration.load(SupplierIO.InputStream)

loadConfiguration(InputStream) - Static method in class org.simpleyaml.configuration.file.YamlFile

Deprecated.

this method loads the entire file into memory, for larger files please use YamlFile.loadConfiguration(SupplierIO.InputStream)

loadConfiguration(InputStream, boolean) - Static method in class org.simpleyaml.configuration.file.YamlFile

Deprecated.

this method loads the entire file into memory, for larger files please use YamlFile.loadConfiguration(SupplierIO.InputStream, boolean)

loadConfiguration(Reader) - Static method in class org.simpleyaml.configuration.file.YamlConfiguration

Deprecated.

this method loads the entire file into memory, for larger files please use YamlConfiguration.load(SupplierIO.Reader)

loadConfiguration(Reader) - Static method in class org.simpleyaml.configuration.file.YamlFile

Deprecated.

this method loads the entire file into memory, for larger files please use YamlFile.loadConfiguration(SupplierIO.Reader)

loadConfiguration(Reader, boolean) - Static method in class org.simpleyaml.configuration.file.YamlFile

Deprecated.

this method loads the entire file into memory, for larger files please use YamlFile.loadConfiguration(SupplierIO.Reader, boolean)

loadConfiguration(SupplierIO.InputStream) - Static method in class org.simpleyaml.configuration.file.YamlConfiguration

Creates a new YamlConfiguration, loading from the given input stream.

loadConfiguration(SupplierIO.InputStream) - Static method in class org.simpleyaml.configuration.file.YamlFile

Creates a new YamlFile, loading from the given stream (without comments).

loadConfiguration(SupplierIO.InputStream, boolean) - Static method in class org.simpleyaml.configuration.file.YamlFile

Creates a new YamlFile, loading from the given stream.

loadConfiguration(SupplierIO.Reader) - Static method in class org.simpleyaml.configuration.file.YamlConfiguration

Creates a new YamlConfiguration, loading from the given reader.

loadConfiguration(SupplierIO.Reader) - Static method in class org.simpleyaml.configuration.file.YamlFile

Creates a new YamlFile, loading from the given reader (without comments).

loadConfiguration(SupplierIO.Reader, boolean) - Static method in class org.simpleyaml.configuration.file.YamlFile

Creates a new YamlFile, loading from the given reader.

loadConfigurationFromString(String) - Static method in class org.simpleyaml.configuration.file.YamlConfiguration

Creates a new YamlConfiguration, loading from the specified string contents.

loadConfigurationFromString(String) - Static method in class org.simpleyaml.configuration.file.YamlFile

Creates a new YamlFile, loading from the specified string contents (without comments).

loadConfigurationFromString(String, boolean) - Static method in class org.simpleyaml.configuration.file.YamlFile

Creates a new YamlFile, loading from the specified string contents.

loaderOptions - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

loadFromString(String) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

Loads this YamlConfiguration from the specified string.

loadFromString(String) - Method in interface org.simpleyaml.configuration.LoadableConfiguration

Loads this configuration from the specified string.

loadHeader(Reader) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

loadWithComments() - Method in class org.simpleyaml.configuration.file.YamlFile

Loads configurations from this configuration file including comments.

M

map - Variable in class org.simpleyaml.configuration.MemorySection

mapChildrenKeys(Set<String>, ConfigurationSection, boolean) - Method in class org.simpleyaml.configuration.MemorySection

mapChildrenValues(Map<String, Object>, ConfigurationSection, boolean) - Method in class org.simpleyaml.configuration.MemorySection

MemoryConfiguration - Class in org.simpleyaml.configuration

This is a Configuration implementation that does not save or load from any source, and stores all values in memory only.

MemoryConfiguration() - Constructor for class org.simpleyaml.configuration.MemoryConfiguration

Creates an empty MemoryConfiguration with no default values.

MemoryConfiguration(Configuration) - Constructor for class org.simpleyaml.configuration.MemoryConfiguration

Creates an empty MemoryConfiguration using the specified Configuration as a source for all default values.

MemoryConfigurationOptions - Class in org.simpleyaml.configuration

Various settings for controlling the input and output of a MemoryConfiguration

MemoryConfigurationOptions(MemoryConfiguration) - Constructor for class org.simpleyaml.configuration.MemoryConfigurationOptions

MemorySection - Class in org.simpleyaml.configuration

A type of ConfigurationSection that is stored in memory.

MemorySection() - Constructor for class org.simpleyaml.configuration.MemorySection

Creates an empty MemorySection for use as a root Configuration section.

MemorySection(ConfigurationSection, String) - Constructor for class org.simpleyaml.configuration.MemorySection

Creates an empty MemorySection with the specified parent and path.

multilineKeyBlock - Variable in class org.simpleyaml.configuration.comments.YamlCommentDumper

N

name - Variable in class org.simpleyaml.configuration.comments.KeyTree.Node

NEW_LINE - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage

NEW_LINE - Static variable in class org.simpleyaml.utils.StringUtils

nextChar() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

nextIsSpace() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

nextLine() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

NO_COMMENTS - Static variable in class org.simpleyaml.configuration.comments.YamlCommentMapper

NONE - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReadingQuoteStyle

nonPrintableStyle - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter

noNullElements(Object[]) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument array is neither null nor contains any elements that are null; otherwise throwing an exception.

noNullElements(Object[], String) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument array is neither null nor contains any elements that are null; otherwise throwing an exception with the specified message.

noNullElements(Collection<?>) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument collection is neither null nor contains any elements that are null; otherwise throwing an exception.

noNullElements(Collection<?>, String) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument collection is neither null nor contains any elements that are null; otherwise throwing an exception with the specified message.

notEmpty(Object[]) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument array is neither null nor a length of zero (no elements); otherwise throwing an exception.

notEmpty(Object[], String) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument array is neither null nor a length of zero (no elements); otherwise throwing an exception with the specified message.

notEmpty(String) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument string is neither null nor a length of zero (no characters); otherwise throwing an exception with the specified message.

notEmpty(String, String) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument string is neither null nor a length of zero (no characters); otherwise throwing an exception with the specified message.

notEmpty(Collection<?>) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument collection is neither null nor a size of zero (no elements); otherwise throwing an exception.

notEmpty(Collection<?>, String) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument collection is neither null nor a size of zero (no elements); otherwise throwing an exception with the specified message.

notEmpty(Map<?, ?>) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument map is neither null nor a size of zero (no elements); otherwise throwing an exception.

notEmpty(Map<?, ?>, String) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument map is neither null nor a size of zero (no elements); otherwise throwing an exception with the specified message.

notNull(Object) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument is not null; otherwise throwing an exception.

notNull(Object, String) - Static method in class org.simpleyaml.utils.Validate

Validate that the specified argument is not null; otherwise throwing an exception with the specified message.

NumberConversions - Class in org.simpleyaml.utils

Utils for casting number types to other number types

O

options - Variable in class org.simpleyaml.configuration.comments.KeyTree

options - Variable in class org.simpleyaml.configuration.implementation.api.YamlImplementationCommentable

Configuration options for loading and dumping Yaml.

options - Variable in class org.simpleyaml.configuration.MemoryConfiguration

options() - Method in class org.simpleyaml.configuration.comments.KeyTree

options() - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

options() - Method in class org.simpleyaml.configuration.comments.YamlKeyTree

options() - Method in interface org.simpleyaml.configuration.Configuration

Gets the ConfigurationOptions for this Configuration.

options() - Method in class org.simpleyaml.configuration.file.FileConfiguration

options() - Method in class org.simpleyaml.configuration.file.YamlConfiguration

options() - Method in class org.simpleyaml.configuration.MemoryConfiguration

org.simpleyaml.configuration - package org.simpleyaml.configuration

org.simpleyaml.configuration.comments - package org.simpleyaml.configuration.comments

org.simpleyaml.configuration.comments.format - package org.simpleyaml.configuration.comments.format

org.simpleyaml.configuration.file - package org.simpleyaml.configuration.file

org.simpleyaml.configuration.implementation - package org.simpleyaml.configuration.implementation

org.simpleyaml.configuration.implementation.api - package org.simpleyaml.configuration.implementation.api

org.simpleyaml.configuration.implementation.snakeyaml - package org.simpleyaml.configuration.implementation.snakeyaml

org.simpleyaml.configuration.serialization - package org.simpleyaml.configuration.serialization

org.simpleyaml.exceptions - package org.simpleyaml.exceptions

org.simpleyaml.utils - package org.simpleyaml.utils

P

padding(int, char) - Static method in class org.simpleyaml.utils.StringUtils

parent - Variable in class org.simpleyaml.configuration.comments.KeyTree.Node

parent - Variable in class org.simpleyaml.configuration.ConfigurationWrapper

parent() - Method in class org.simpleyaml.configuration.ConfigurationWrapper

Returns to the parent.

parent() - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

parse() - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

parse(Reader) - Method in interface org.simpleyaml.configuration.comments.format.CommentFormatter

parse(Reader, CommentType) - Method in interface org.simpleyaml.configuration.comments.format.CommentFormatter

parse(Reader, CommentType, KeyTree.Node) - Method in interface org.simpleyaml.configuration.comments.format.CommentFormatter

Parse the comment from a reader that may contain a raw-formatted comment (for instance from a configuration file) to a human-friendly contentful representation of that comment.

parse(Reader, CommentType, KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

parse(Reader, CommentType, KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

parse(String) - Method in interface org.simpleyaml.configuration.comments.format.CommentFormatter

parse(String, CommentType) - Method in interface org.simpleyaml.configuration.comments.format.CommentFormatter

parse(String, CommentType, KeyTree.Node) - Method in interface org.simpleyaml.configuration.comments.format.CommentFormatter

Parse the comment from a string that may contain a raw-formatted comment (for instance from a configuration file) to a human-friendly contentful representation of that comment.

parse(String, CommentType, KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

Parse the header of a contents string, like a file contents.

parseCommentLine(String, String, boolean) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

parseComments(Reader) - Method in class org.simpleyaml.configuration.implementation.SimpleYamlImplementation

Parse comments from a reader.

path - Variable in class org.simpleyaml.configuration.ConfigurationWrapper

path(String) - Method in class org.simpleyaml.configuration.ConfigurationWrapper

Get a wrapper builder for the given child path.

path(String) - Method in class org.simpleyaml.configuration.file.YamlFile

Get a wrapper builder to set a value to the given path and optionally set comments.

path(String) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

pathSeparator() - Method in class org.simpleyaml.configuration.ConfigurationOptions

Gets the char that will be used to separate ConfigurationSections

pathSeparator(char) - Method in class org.simpleyaml.configuration.ConfigurationOptions

Sets the char that will be used to separate ConfigurationSections

pathSeparator(char) - Method in class org.simpleyaml.configuration.file.FileConfigurationOptions

pathSeparator(char) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

pathSeparator(char) - Method in class org.simpleyaml.configuration.MemoryConfigurationOptions

peek(int) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

PLAIN - Enum constant in enum org.simpleyaml.configuration.implementation.api.QuoteStyle

Default style, without quotes when possible.

position - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

prefix(String) - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

prefix(String) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

prefix(String) - Method in class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

prefix(String, String) - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

prefix(String, String) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

prefix(String, String) - Method in class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

prefixFirst() - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

prefixFirst(String) - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

prefixFirst(String) - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

Sets the comment prefix to apply to the beginning of the header.

prefixMultiline() - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

prefixMultiline(String) - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

PRETTY - Enum constant in enum org.simpleyaml.configuration.comments.format.YamlCommentFormat

PRETTY comment format gets comments in a readable way stripping the # comment prefix, without leading and trailing spaces or blank lines and without indentation.

PrettyYamlCommentFormatter - Class in org.simpleyaml.configuration.comments.format

YamlCommentFormat.PRETTY formatter

PrettyYamlCommentFormatter() - Constructor for class org.simpleyaml.configuration.comments.format.PrettyYamlCommentFormatter

PrettyYamlCommentFormatter(YamlCommentFormatterConfiguration) - Constructor for class org.simpleyaml.configuration.comments.format.PrettyYamlCommentFormatter

PrettyYamlCommentFormatter(YamlCommentFormatterConfiguration, YamlSideCommentFormatterConfiguration) - Constructor for class org.simpleyaml.configuration.comments.format.PrettyYamlCommentFormatter

priorityIndex - Variable in class org.simpleyaml.configuration.comments.KeyTree.Node

processLine() - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

processLine() - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

processLine() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

processMultiline(boolean) - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

processMultiline(boolean) - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

processMultiline(boolean) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

Q

QUOTE_CLOSE - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage

QUOTE_OPEN - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage

quoteNewLines(String) - Static method in class org.simpleyaml.utils.StringUtils

quoteNotation - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

quoteStyle - Variable in class org.simpleyaml.configuration.implementation.api.QuoteValue

QuoteStyle - Enum in org.simpleyaml.configuration.implementation.api

quoteStyleDefaults() - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

Get the quote style default options.

QuoteValue<T> - Class in org.simpleyaml.configuration.implementation.api

QuoteValue(T, QuoteStyle) - Constructor for class org.simpleyaml.configuration.implementation.api.QuoteValue

R

RAW - Enum constant in enum org.simpleyaml.configuration.comments.format.YamlCommentFormat

RAW comment format gets comments as they are in the file configuration, with blank lines and the comment prefix with # character, but without the indentation prefix.

reader - Variable in class org.simpleyaml.configuration.comments.YamlCommentParser

readIndent() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

readIndent(boolean) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

readKey() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

readKeyMultiline(StringBuilder) - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

readKeyMultiline(StringBuilder) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

readLine() - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

readLine() - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

readLine() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

readTag() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

readValue() - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

readValue() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

readValueMultiline() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

registerClass(Class<? extends ConfigurationSerializable>) - Static method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

Registers the given ConfigurationSerializable class by its alias

registerClass(Class<? extends ConfigurationSerializable>, String) - Static method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

Registers the given alias to the specified ConfigurationSerializable class

remove(String) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Removes the specified path if it exists.

removeComment(String, CommentType) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

removeComment(KeyTree.Node, CommentType) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

removeHeader(String, YamlConfigurationOptions) - Static method in class org.simpleyaml.configuration.comments.YamlCommentParser

reset() - Static method in enum org.simpleyaml.configuration.comments.format.YamlCommentFormat

resolveAnchor(Node) - Static method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

resolver - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

root - Variable in class org.simpleyaml.configuration.comments.KeyTree

round(double) - Static method in class org.simpleyaml.utils.NumberConversions

runThread(DumperBus.Task) - Method in class org.simpleyaml.utils.DumperBus

Start a new thread executing a task.

S

save() - Method in class org.simpleyaml.configuration.file.YamlFile

Saves this FileConfiguration to the configuration file location.

save(File) - Method in class org.simpleyaml.configuration.file.FileConfiguration

Saves this FileConfiguration to the specified location.

save(Writer) - Method in class org.simpleyaml.configuration.file.FileConfiguration

save(Writer) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

Save the configuration values including the header.

save(Writer) - Method in interface org.simpleyaml.configuration.LoadableConfiguration

Saves this configuration to a writer.

save(String) - Method in class org.simpleyaml.configuration.file.FileConfiguration

Saves this FileConfiguration to the specified location.

saveToString() - Method in class org.simpleyaml.configuration.file.YamlConfiguration

Save the configuration values including the header to a string.

saveToString() - Method in class org.simpleyaml.configuration.file.YamlFile

Saves this YamlFile to a string and returns it.

saveToString() - Method in interface org.simpleyaml.configuration.LoadableConfiguration

Saves this configuration to a string, and returns it.

sectionToMapping(ConfigurationSection, KeyTree.Node, SnakeYamlCommentMapper) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

SectionUtils - Class in org.simpleyaml.utils

SectionUtils() - Constructor for class org.simpleyaml.utils.SectionUtils

SerializableAs - Annotation Type in org.simpleyaml.configuration.serialization

Represents an "alias" that a ConfigurationSerializable may be stored as.

serialize() - Method in interface org.simpleyaml.configuration.serialization.ConfigurationSerializable

Creates a Map representation of this class.

SERIALIZED_TYPE_KEY - Static variable in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

set(Object) - Method in class org.simpleyaml.configuration.ConfigurationWrapper

Set the given value to this path.

set(Object) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

set(Object, QuoteStyle) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

Set the given value to this path.

set(String, Object) - Method in interface org.simpleyaml.configuration.ConfigurationSection

Sets the specified path to the given value.

set(String, Object) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

Sets the specified path to the given value.

set(String, Object) - Method in class org.simpleyaml.configuration.file.YamlFile

set(String, Object) - Method in class org.simpleyaml.configuration.MemorySection

set(String, Object, QuoteStyle) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

Sets the specified path to the given value.

set(String, T) - Method in interface org.simpleyaml.configuration.ConfigurationWrapper.SetToPath

set(ConfigurationWrapper.SetToPath, Object) - Method in class org.simpleyaml.configuration.ConfigurationWrapper

setBlankLine(String) - Method in class org.simpleyaml.configuration.file.YamlFile

Set a blank line at the beginning of the block comment.

setChild(String, Object) - Method in class org.simpleyaml.configuration.ConfigurationWrapper

Set the given value to the provided child path.

setChild(String, Object) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

setChild(String, Object, QuoteStyle) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper

Set the given value to the provided child path.

setComment(String) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

setComment(String, String) - Method in interface org.simpleyaml.configuration.comments.Commentable

Set a block comment above the section or value selected by path.

setComment(String, String) - Method in class org.simpleyaml.configuration.file.YamlFile

Set a block comment above the section or value selected by path.

setComment(String, String, CommentType) - Method in interface org.simpleyaml.configuration.comments.Commentable

Set a comment to the section or value selected by path.

setComment(String, String, CommentType) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

setComment(String, String, CommentType) - Method in class org.simpleyaml.configuration.file.YamlFile

Set a comment to the section or value selected by path.

setComment(String, String, CommentType) - Method in class org.simpleyaml.configuration.implementation.api.YamlImplementationCommentable

setComment(String, String, CommentType) - Method in class org.simpleyaml.configuration.implementation.SimpleYamlImplementation

setComment(String, String, CommentType) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

setComment(String, String, CommentType, YamlCommentFormat) - Method in class org.simpleyaml.configuration.file.YamlFile

Set a comment to the section or value selected by path.

setComment(String, String, CommentType, YamlCommentFormatter) - Method in class org.simpleyaml.configuration.file.YamlFile

Set a comment to the section or value selected by path.

setComment(String, String, YamlCommentFormat) - Method in class org.simpleyaml.configuration.file.YamlFile

Set a block comment to the section or value selected by path.

setComment(String, String, YamlCommentFormatter) - Method in class org.simpleyaml.configuration.file.YamlFile

Set a block comment to the section or value selected by path.

setCommentFormat(YamlCommentFormat) - Method in class org.simpleyaml.configuration.file.YamlFile

Change the comment formatter to one of the defaults provided by YamlCommentFormat.

setCommentFormat(YamlCommentFormatter) - Method in class org.simpleyaml.configuration.file.YamlFile

Change the comment formatter for parsing and dumping comments.

setCommentPrefix(YamlConfigurationOptions) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

setComments(KeyTree.Node, Node, Node) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

setCommentsMapping(MappingNode, KeyTree.Node, SnakeYamlCommentMapper) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

setCommentsSequence(SequenceNode, KeyTree.Node, SnakeYamlCommentMapper) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

setConfigurationFile(File) - Method in class org.simpleyaml.configuration.file.YamlFile

Rebuilds this FileConfiguration with a source file.

setConfigurationFile(String) - Method in class org.simpleyaml.configuration.file.YamlFile

Rebuilds this FileConfiguration with the file specified by path.

setConfigurationFile(URI) - Method in class org.simpleyaml.configuration.file.YamlFile

Rebuilds this FileConfiguration with the file specified by uri.

setDefaultQuoteStyle(QuoteStyle) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions.QuoteStyleDefaults

Set the default quote style.

setDefaults(Configuration) - Method in interface org.simpleyaml.configuration.Configuration

Sets the source of all default values for this Configuration.

setDefaults(Configuration) - Method in class org.simpleyaml.configuration.MemoryConfiguration

setElementIndex(int) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

setFooter(String) - Method in class org.simpleyaml.configuration.file.YamlFile

Sets the footer of this configuration file.

setFooter(MappingNode) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

setFormattedComment(KeyTree.Node, String, CommentType) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

setHeader(String) - Method in class org.simpleyaml.configuration.file.YamlFile

Sets the header that will be applied to the top of the saved output.

setImplementation(YamlImplementation) - Method in class org.simpleyaml.configuration.file.YamlConfiguration

setListNode(Collection<?>, KeyTree.Node) - Method in class org.simpleyaml.configuration.file.YamlFile

setPriority(String, KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

setQuoteStyle(Class<?>, QuoteStyle) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions.QuoteStyleDefaults

Set the default quote style for a specific type.

setRawComment(KeyTree.Node, String, CommentType) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper

setSeparator(char) - Static method in class org.simpleyaml.utils.StringUtils

setSideComment(String) - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

setSideComment(KeyTree.Node, String) - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

setTimeZone(TimeZone) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter

setToChild(ConfigurationWrapper.SetToPath, String, Object) - Method in class org.simpleyaml.configuration.ConfigurationWrapper

SIDE - Enum constant in enum org.simpleyaml.configuration.comments.CommentType

sideComment - Variable in class org.simpleyaml.configuration.comments.KeyTree.Node

sideCommentPrefix - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

sideFormatter - Variable in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

sideFormatter() - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

SimpleYamlImplementation - Class in org.simpleyaml.configuration.implementation

Default YAML implementation using snakeyaml high-level API and a custom comment parser / dumper.

SimpleYamlImplementation() - Constructor for class org.simpleyaml.configuration.implementation.SimpleYamlImplementation

SimpleYamlImplementation(SnakeYamlConstructor, SnakeYamlRepresenter) - Constructor for class org.simpleyaml.configuration.implementation.SimpleYamlImplementation

SimpleYamlImplementation(SnakeYamlConstructor, SnakeYamlRepresenter, Resolver) - Constructor for class org.simpleyaml.configuration.implementation.SimpleYamlImplementation

SimpleYamlImplementation(SnakeYamlRepresenter) - Constructor for class org.simpleyaml.configuration.implementation.SimpleYamlImplementation

SimpleYamlImplementation(LoaderOptions, DumperOptions) - Constructor for class org.simpleyaml.configuration.implementation.SimpleYamlImplementation

SINGLE - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReadingQuoteStyle

SINGLE - Enum constant in enum org.simpleyaml.configuration.implementation.api.QuoteStyle

Wrap values with single quotes.

size() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

size() - Method in interface org.simpleyaml.configuration.ConfigurationSection

Gets the size of this configuration section.

size() - Method in class org.simpleyaml.configuration.MemorySection

skipMultiline() - Method in class org.simpleyaml.configuration.comments.YamlCommentDumper

skipToEnd() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

SnakeYamlCommentMapper - Class in org.simpleyaml.configuration.implementation.snakeyaml

SnakeYamlCommentMapper(YamlConfigurationOptions) - Constructor for class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

SnakeYamlConstructor - Class in org.simpleyaml.configuration.implementation.snakeyaml

SnakeYamlConstructor(LoaderOptions) - Constructor for class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlConstructor

SnakeYamlImplementation - Class in org.simpleyaml.configuration.implementation.snakeyaml

YAML implementation using snakeyaml low-level API and snakeyaml comment processing available if YamlConfigurationOptions.useComments() is enabled.

SnakeYamlImplementation() - Constructor for class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

SnakeYamlImplementation(SnakeYamlConstructor, SnakeYamlRepresenter) - Constructor for class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

SnakeYamlImplementation(SnakeYamlConstructor, SnakeYamlRepresenter, Resolver) - Constructor for class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

SnakeYamlImplementation(SnakeYamlRepresenter) - Constructor for class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

SnakeYamlImplementation(LoaderOptions, DumperOptions) - Constructor for class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

SnakeYamlQuoteValue - Class in org.simpleyaml.configuration.implementation.snakeyaml

SnakeYamlQuoteValue() - Constructor for class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlQuoteValue

SnakeYamlRepresenter - Class in org.simpleyaml.configuration.implementation.snakeyaml

SnakeYamlRepresenter(DumperOptions) - Constructor for class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter

source() - Method in class org.simpleyaml.utils.DumperBus

Get the dumper source where values are read.

splitNewLines(String, int) - Static method in class org.simpleyaml.utils.StringUtils

splitTrailingNewLines(String) - Static method in class org.simpleyaml.utils.StringUtils

square(double) - Static method in class org.simpleyaml.utils.NumberConversions

stage - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

START - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage

StringUtils - Class in org.simpleyaml.utils

StringUtils() - Constructor for class org.simpleyaml.utils.StringUtils

stripCarriage(String) - Static method in class org.simpleyaml.utils.StringUtils

stripIndentation(String) - Static method in class org.simpleyaml.utils.StringUtils

stripPrefix() - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

stripPrefix() - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

If strip is true then String.trim() will be applied to every line of the header and the YamlHeaderFormatter.commentPrefix() will be stripped away.

stripPrefix(boolean) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

Set if stripping the prefix is desired.

stripPrefix(boolean) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

stripPrefix(boolean) - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

Set if stripping the prefix is desired.

stripPrefix(boolean) - Method in class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

stripPrefix(String, String) - Static method in class org.simpleyaml.utils.StringUtils

stripPrefix(String, String, String) - Static method in class org.simpleyaml.utils.StringUtils

suffix(String) - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

suffix(String) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

suffix(String) - Method in class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

suffix(String, String) - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

suffix(String, String) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

suffix(String, String) - Method in class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

suffixLast() - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

suffixLast(String) - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

suffixLast(String) - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

Set the suffix to append to the end of the header.

suffixMultiline() - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

suffixMultiline(String) - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

SupplierIO<T extends Closeable> - Interface in org.simpleyaml.utils

IO Factory.

SupplierIO.InputStream - Interface in org.simpleyaml.utils

InputStream get()
Can be implemented as a lambda function. e.g.

SupplierIO.Reader - Interface in org.simpleyaml.utils

Reader get()
Can be implemented as a lambda function. e.g.

T

timeZone - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter

toByte(Object) - Static method in class org.simpleyaml.utils.NumberConversions

toChar(Object) - Static method in class org.simpleyaml.utils.CharacterConversions

toDouble(Object) - Static method in class org.simpleyaml.utils.NumberConversions

toFloat(Object) - Static method in class org.simpleyaml.utils.NumberConversions

toInt(Object) - Static method in class org.simpleyaml.utils.NumberConversions

toLong(Object) - Static method in class org.simpleyaml.utils.NumberConversions

toShort(Object) - Static method in class org.simpleyaml.utils.NumberConversions

toString() - Method in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

toString() - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

toString() - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

toString() - Method in class org.simpleyaml.configuration.comments.KeyTree.Node

toString() - Method in class org.simpleyaml.configuration.comments.KeyTree

toString() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

toString() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

toString() - Method in class org.simpleyaml.configuration.file.YamlFile

Returns a representation of this configuration file.

toString() - Method in class org.simpleyaml.configuration.implementation.api.QuoteValue

toString() - Method in class org.simpleyaml.configuration.MemorySection

track() - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

track() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

track() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

track(int, String) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

track(KeyTree.Node, int, String) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

track(KeyTree.Node, String, Node, Node) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

trackBlockComment(KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

trackBlockComment(KeyTree.Node, List<CommentLine>) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

trackBlockCommentExplicit(KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

trackElement(KeyTree.Node, String, Node, int) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

trackExplicit() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

trackFooter(MappingNode) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

trackListElement() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

trackListElement(int) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader

trackMapping(MappingNode, ConfigurationSection, KeyTree.Node, SnakeYamlCommentMapper) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

trackSequence(SequenceNode, KeyTree.Node, SnakeYamlCommentMapper) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

trackSideComment(KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

trackSideComment(KeyTree.Node, List<CommentLine>) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlCommentMapper

trackSideCommentBelow() - Method in class org.simpleyaml.configuration.comments.YamlCommentParser

trim - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader

trim() - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

trim(boolean) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

Set if leading and trailing spaces and blank lines at the beginning and end of the comments should be stripped away.

trim(boolean) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

trim(boolean) - Method in class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

U

unregisterClass(Class<? extends ConfigurationSerializable>) - Static method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

Unregisters any aliases for the specified ConfigurationSerializable class

unregisterClass(String) - Static method in class org.simpleyaml.configuration.serialization.ConfigurationSerialization

Unregisters the specified alias to a ConfigurationSerializable

useComments() - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

Indicates if parsing comments is enabled.

useComments(boolean) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions

Sets if parsing comments is needed.

V

Validate - Class in org.simpleyaml.utils

This class assists in validating arguments.

Validate() - Constructor for class org.simpleyaml.utils.Validate

Constructor.

value - Variable in class org.simpleyaml.configuration.implementation.api.QuoteValue

value() - Element in annotation type org.simpleyaml.configuration.serialization.DelegateDeserialization

Which class should be used as a delegate for this classes deserialization

value() - Element in annotation type org.simpleyaml.configuration.serialization.SerializableAs

This is the name your class will be stored and retrieved as.

VALUE - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage

VALUE - Static variable in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

valueOf(String) - Static method in enum org.simpleyaml.configuration.comments.CommentType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.simpleyaml.configuration.comments.format.YamlCommentFormat

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReadingQuoteStyle

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.simpleyaml.configuration.implementation.api.QuoteStyle

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.simpleyaml.configuration.comments.CommentType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.simpleyaml.configuration.comments.format.YamlCommentFormat

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReadingQuoteStyle

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.simpleyaml.configuration.implementation.api.QuoteStyle

Returns an array containing the constants of this enum type, in the order they are declared.

valueStep() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle

W

wrap(String) - Static method in class org.simpleyaml.utils.StringUtils

write(char[], int, int) - Method in class org.simpleyaml.utils.DumperBus

Append to line a portion of an array of characters.

writer - Variable in class org.simpleyaml.configuration.comments.YamlCommentDumper

Y

yaml - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

YamlCommentDumper - Class in org.simpleyaml.configuration.comments

YamlCommentDumper(YamlCommentMapper, DumperBus.Dumper, Writer) - Constructor for class org.simpleyaml.configuration.comments.YamlCommentDumper

YamlCommentFormat - Enum in org.simpleyaml.configuration.comments.format

YamlCommentFormat.YamlCommentFormatterFactory - Interface in org.simpleyaml.configuration.comments.format

YamlCommentFormatter - Class in org.simpleyaml.configuration.comments.format

Comment formatter to parse and dump YAML comments (using the # prefix).

YamlCommentFormatter() - Constructor for class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

YamlCommentFormatter(YamlCommentFormatterConfiguration) - Constructor for class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

YamlCommentFormatter(YamlCommentFormatterConfiguration, YamlSideCommentFormatterConfiguration) - Constructor for class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

YamlCommentFormatterConfiguration - Class in org.simpleyaml.configuration.comments.format

YamlCommentFormatterConfiguration() - Constructor for class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

YamlCommentFormatterConfiguration(String) - Constructor for class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

YamlCommentFormatterConfiguration(String, String) - Constructor for class org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

yamlCommentMapper - Variable in class org.simpleyaml.configuration.comments.YamlCommentDumper

yamlCommentMapper - Variable in class org.simpleyaml.configuration.implementation.api.YamlImplementationCommentable

A comment mapper to add comments to sections or values

YamlCommentMapper - Class in org.simpleyaml.configuration.comments

YamlCommentMapper(YamlKeyTree) - Constructor for class org.simpleyaml.configuration.comments.YamlCommentMapper

YamlCommentMapper(YamlConfigurationOptions) - Constructor for class org.simpleyaml.configuration.comments.YamlCommentMapper

YamlCommentParser - Class in org.simpleyaml.configuration.comments

YamlCommentParser(YamlConfigurationOptions, Reader) - Constructor for class org.simpleyaml.configuration.comments.YamlCommentParser

YamlCommentReader - Class in org.simpleyaml.configuration.comments

YamlCommentReader(YamlConfigurationOptions) - Constructor for class org.simpleyaml.configuration.comments.YamlCommentReader

YamlCommentReader.ReaderStage - Enum in org.simpleyaml.configuration.comments

YamlCommentReader.ReadingExplicitStyle - Class in org.simpleyaml.configuration.comments

YamlCommentReader.ReadingQuoteStyle - Enum in org.simpleyaml.configuration.comments

YamlConfiguration - Class in org.simpleyaml.configuration.file

An implementation of Configuration which saves the configuration in Yaml.

YamlConfiguration() - Constructor for class org.simpleyaml.configuration.file.YamlConfiguration

Creates an empty YamlConfiguration.

YamlConfiguration(Configuration) - Constructor for class org.simpleyaml.configuration.file.YamlConfiguration

Creates an empty YamlConfiguration using the specified Configuration as a source for all default values.

YamlConfiguration(Configuration, YamlImplementation) - Constructor for class org.simpleyaml.configuration.file.YamlConfiguration

YamlConfiguration(YamlImplementation) - Constructor for class org.simpleyaml.configuration.file.YamlConfiguration

YamlConfigurationOptions - Class in org.simpleyaml.configuration.file

Various settings for controlling the input and output of a YamlConfiguration

YamlConfigurationOptions(YamlConfiguration) - Constructor for class org.simpleyaml.configuration.file.YamlConfigurationOptions

YamlConfigurationOptions.QuoteStyleDefaults - Class in org.simpleyaml.configuration.file

Options to configure the default QuoteStyle for each type.

yamlConstructor - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

YamlFile - Class in org.simpleyaml.configuration.file

An extension of YamlConfiguration which saves all data in Yaml to a configuration file with the added possibility to save and manage comments.

YamlFile() - Constructor for class org.simpleyaml.configuration.file.YamlFile

Builds this YamlFile without any configuration file.

YamlFile(File) - Constructor for class org.simpleyaml.configuration.file.YamlFile

Builds this FileConfiguration with a source file.

YamlFile(String) - Constructor for class org.simpleyaml.configuration.file.YamlFile

Builds this FileConfiguration with the file specified by path.

YamlFile(URI) - Constructor for class org.simpleyaml.configuration.file.YamlFile

Builds this FileConfiguration with the file specified by uri.

YamlFile(URL) - Constructor for class org.simpleyaml.configuration.file.YamlFile

Builds this FileConfiguration with the file specified by url.

YamlFile(YamlImplementation) - Constructor for class org.simpleyaml.configuration.file.YamlFile

Builds this YamlFile without any configuration file.

YamlFileWrapper - Class in org.simpleyaml.configuration.file

An alternative API to set values along with comments for a path.

YamlFileWrapper(YamlFile, String) - Constructor for class org.simpleyaml.configuration.file.YamlFileWrapper

YamlFileWrapper(YamlFile, String, YamlFileWrapper) - Constructor for class org.simpleyaml.configuration.file.YamlFileWrapper

YamlHeaderFormatter - Class in org.simpleyaml.configuration.comments.format

The header is the first block comment at the top of the configuration file.

YamlHeaderFormatter() - Constructor for class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

YamlHeaderFormatter(String, boolean) - Constructor for class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

YamlHeaderFormatter(YamlCommentFormatterConfiguration) - Constructor for class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter

yamlImplementation - Variable in class org.simpleyaml.configuration.file.YamlConfiguration

YamlImplementation - Interface in org.simpleyaml.configuration.implementation.api

A YAML implementation to load/parse and dump/save a ConfigurationSection.

YamlImplementationCommentable - Class in org.simpleyaml.configuration.implementation.api

A YAML implementation capable of processing comments.

YamlImplementationCommentable() - Constructor for class org.simpleyaml.configuration.implementation.api.YamlImplementationCommentable

YamlKeyTree - Class in org.simpleyaml.configuration.comments

YamlKeyTree(YamlConfigurationOptions) - Constructor for class org.simpleyaml.configuration.comments.YamlKeyTree

YamlKeyTree.YamlCommentNode - Class in org.simpleyaml.configuration.comments

yamlRepresenter - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

YamlSideCommentFormatterConfiguration - Class in org.simpleyaml.configuration.comments.format

YamlSideCommentFormatterConfiguration() - Constructor for class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

YamlSideCommentFormatterConfiguration(String) - Constructor for class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

YamlSideCommentFormatterConfiguration(String, String) - Constructor for class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

A B C D E F G H I K L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form