Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- 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.file.YamlFileWrapper
- addDefault(String, Object) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper
- addKey(String, boolean) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle
- AFTER_KEY - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage
- 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
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.
- 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_LINEformatter - 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
- 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
- bus - Variable in class org.simpleyaml.configuration.comments.YamlCommentDumper
C
- canStartComment() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader
- canStartSpecialIndent(int) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader
- 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
- checkSpecialChars() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader
- checkSpecialLines(boolean, int) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader
- classTags - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter
- 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
- 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
- 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
- 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.
- 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.
- configuration - Variable in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter
- configuration() - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions
- 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
- copyDefaults(boolean) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions
- 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.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.
- createSection() - Method in class org.simpleyaml.configuration.file.YamlFileWrapper
- createSection(String) - Method in class org.simpleyaml.configuration.file.YamlFileWrapper
- 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
- deleteFile() - Method in class org.simpleyaml.configuration.file.YamlFile
-
Deletes this configuration file from disk.
- 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(Writer) - Method in class org.simpleyaml.configuration.file.YamlConfiguration
-
Dump the configuration values without the header.
- 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, CommentType, KeyTree.Node) - Method in class org.simpleyaml.configuration.comments.format.BlankLineYamlCommentFormatter
- 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.
- dumperOptions - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation
- dumpYaml(Writer, ConfigurationSection) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation
E
- 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
- 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.file.YamlConfigurationOptions
- equals(Object) - Method in class org.simpleyaml.configuration.implementation.api.QuoteValue
- 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
- fileToString() - Method in class org.simpleyaml.configuration.file.YamlFile
-
Returns a representation of the already saved configuration file.
- finish() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle
- firstListMapElement - Variable in class org.simpleyaml.configuration.comments.YamlCommentDumper
- flattenMapping(MappingNode) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlConstructor
- FOLDED - Enum constant in enum org.simpleyaml.configuration.implementation.api.QuoteStyle
-
folded:
>-Each line is literal and are joined with spaces - formatterConfiguration(CommentType) - Method in class org.simpleyaml.configuration.comments.format.YamlCommentFormatter
G
- get(String, Object) - Method in class org.simpleyaml.configuration.file.YamlConfiguration
- getChar() - Method in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReadingQuoteStyle
- 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 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.
- getConstructor() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation
- getDefaultQuoteStyle() - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions.QuoteStyleDefaults
-
Get the default quote style.
- getDumperOptions() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation
- getDumperOptions() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter
- getFilePath() - Method in class org.simpleyaml.configuration.file.YamlFile
-
Returns the absolute pathname string of this configuration file.
- 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.YamlCommentReader.ReadingExplicitStyle
- getKey() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle
- getKeyComment() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle
- getKeyTree() - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper
- getLoaderOptions() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation
- 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
- getOrAddNode(String) - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper
- 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
- 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
- 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.implementation.api.QuoteValue
- getValueComment() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle
- getYaml() - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation
H
- hasChar() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader
- hasContent(Writer, ConfigurationSection) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation
- 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.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(String) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions
- headerFormatter() - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions
- 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.YamlCommentReader
- indent(int) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions
-
Sets how much spaces should be used to indent each line.
- 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.
- inQuote(YamlCommentReader.ReadingQuoteStyle) - Method in class org.simpleyaml.configuration.comments.YamlCommentReader
- isBlank() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader
- isComment() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader
- 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
- isInQuote() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader
- isKey() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle
- isList(int) - Method in class org.simpleyaml.configuration.comments.YamlKeyTree.YamlCommentNode
- 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
- isMultiline() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader
- isSectionEnd() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader
- isSectionKey() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader
- isSpace(char) - Static method in class org.simpleyaml.configuration.comments.YamlCommentReader
- isValue() - Method in class org.simpleyaml.configuration.comments.YamlCommentReader.ReadingExplicitStyle
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
- keyTree - Variable in class org.simpleyaml.configuration.comments.YamlCommentMapper
L
- 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.YamlConfiguration
-
Loads this configuration from the specified file.
- load(InputStream) - Method in class org.simpleyaml.configuration.file.YamlConfiguration
-
Deprecated.
- 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, 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, 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
YamlConfigurationfrom the specified reader. - load(SupplierIO.Reader) - Method in class org.simpleyaml.configuration.file.YamlFile
-
Loads this
YamlFilefrom 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
- 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
YamlConfigurationfrom 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
- multilineKeyBlock - Variable in class org.simpleyaml.configuration.comments.YamlCommentDumper
N
- NEW_LINE - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage
- 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
O
- options - Variable in class org.simpleyaml.configuration.implementation.api.YamlImplementationCommentable
-
Configuration options for loading and dumping Yaml.
- options() - Method in class org.simpleyaml.configuration.comments.YamlCommentMapper
- options() - Method in class org.simpleyaml.configuration.comments.YamlKeyTree
- options() - Method in class org.simpleyaml.configuration.file.YamlConfiguration
- 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
P
- parent() - Method in class org.simpleyaml.configuration.file.YamlFileWrapper
- parse() - Method in class org.simpleyaml.configuration.comments.YamlCommentParser
- 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, 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(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(char) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions
- 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.YamlCommentFormatterConfiguration
- prefix(String) - Method in class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration
- 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(String) - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter
-
Sets the comment prefix to apply to the beginning of the header.
- 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.PRETTYformatter - 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
- 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
- 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
- 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
S
- save() - Method in class org.simpleyaml.configuration.file.YamlFile
-
Saves this
FileConfigurationto the configuration file location. - save(Writer) - Method in class org.simpleyaml.configuration.file.YamlConfiguration
-
Save the configuration values including the header.
- 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
YamlFileto a string and returns it. - sectionToMapping(ConfigurationSection, KeyTree.Node, SnakeYamlCommentMapper) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation
- 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 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, QuoteStyle) - Method in class org.simpleyaml.configuration.file.YamlConfiguration
-
Sets the specified path to the given value.
- 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.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, 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 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
FileConfigurationwith a source file. - setConfigurationFile(String) - Method in class org.simpleyaml.configuration.file.YamlFile
-
Rebuilds this
FileConfigurationwith the file specified by path. - setConfigurationFile(URI) - Method in class org.simpleyaml.configuration.file.YamlFile
-
Rebuilds this
FileConfigurationwith the file specified by uri. - setDefaultQuoteStyle(QuoteStyle) - Method in class org.simpleyaml.configuration.file.YamlConfigurationOptions.QuoteStyleDefaults
-
Set the default quote style.
- 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
- 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
- setSideComment(KeyTree.Node, String) - Method in class org.simpleyaml.configuration.comments.YamlCommentParser
- setTimeZone(TimeZone) - Method in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter
- 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.
- 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
- stage - Variable in class org.simpleyaml.configuration.comments.YamlCommentReader
- START - Enum constant in enum org.simpleyaml.configuration.comments.YamlCommentReader.ReaderStage
- 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 theYamlHeaderFormatter.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
- 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.YamlCommentFormatterConfiguration
- suffix(String, String) - Method in class org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration
- suffixLast(String) - Method in class org.simpleyaml.configuration.comments.format.YamlHeaderFormatter
-
Set the suffix to append to the end of the header.
T
- timeZone - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlRepresenter
- 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.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
- 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
- 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
- value - Variable in class org.simpleyaml.configuration.implementation.api.QuoteValue
- 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.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.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
- 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
Configurationwhich 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
YamlConfigurationusing the specifiedConfigurationas 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
QuoteStylefor each type. - yamlConstructor - Variable in class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation
- YamlFile - Class in org.simpleyaml.configuration.file
-
An extension of
YamlConfigurationwhich 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
YamlFilewithout any configuration file. - YamlFile(File) - Constructor for class org.simpleyaml.configuration.file.YamlFile
-
Builds this
FileConfigurationwith a source file. - YamlFile(String) - Constructor for class org.simpleyaml.configuration.file.YamlFile
-
Builds this
FileConfigurationwith the file specified by path. - YamlFile(URI) - Constructor for class org.simpleyaml.configuration.file.YamlFile
-
Builds this
FileConfigurationwith the file specified by uri. - YamlFile(URL) - Constructor for class org.simpleyaml.configuration.file.YamlFile
-
Builds this
FileConfigurationwith the file specified by url. - YamlFile(YamlImplementation) - Constructor for class org.simpleyaml.configuration.file.YamlFile
-
Builds this
YamlFilewithout 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
All Classes and Interfaces|All Packages|Constant Field Values
YamlConfiguration.load(SupplierIO.InputStream)