Class YamlConfigurationWriter
- java.lang.Object
-
- org.infinispan.commons.configuration.io.AbstractConfigurationWriter
-
- org.infinispan.commons.configuration.io.yaml.YamlConfigurationWriter
-
- All Implemented Interfaces:
AutoCloseable
,ConfigurationWriter
public class YamlConfigurationWriter extends AbstractConfigurationWriter
- Since:
- 12.1
- Author:
- Tristan Tarrant <[email protected]>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.infinispan.commons.configuration.io.AbstractConfigurationWriter
AbstractConfigurationWriter.Tag
-
Nested classes/interfaces inherited from interface org.infinispan.commons.configuration.io.ConfigurationWriter
ConfigurationWriter.Builder
-
-
Field Summary
Fields Modifier and Type Field Description static int
INDENT
-
Fields inherited from class org.infinispan.commons.configuration.io.AbstractConfigurationWriter
clearTextSecrets, currentIndent, namespaces, naming, prettyPrint, tagStack, writer
-
-
Constructor Summary
Constructors Constructor Description YamlConfigurationWriter(Writer writer, boolean clearTextSecrets)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
hasFeature(ConfigurationFormatFeature feature)
void
writeArrayElement(String outer, String inner, String attribute, Iterable<String> values)
void
writeAttribute(String name, Iterable<String> values)
void
writeAttribute(String name, String value)
void
writeCharacters(String chars)
void
writeComment(String comment)
void
writeDefaultNamespace(String namespace)
void
writeEmptyElement(String name)
void
writeEndArrayElement()
void
writeEndDocument()
void
writeEndElement()
void
writeEndMap()
void
writeEndMapItem()
void
writeMapItem(String element, String name, String key)
Writes a complex map entry.void
writeMapItem(String element, String name, String key, String value)
Writes a simple map entry.void
writeNamespace(String prefix, String namespace)
void
writeStartArrayElement(String name)
Writes an array element.void
writeStartDocument()
void
writeStartElement(String name)
void
writeStartElement(String prefix, String namespace, String name)
void
writeStartListElement(String name, boolean explicit)
Starts a list element.void
writeStartListElement(String prefix, String namespace, String name, boolean explicit)
void
writeStartMap(String name)
-
Methods inherited from class org.infinispan.commons.configuration.io.AbstractConfigurationWriter
clearTextSecrets, close, indent, nl, outdent, tab, writeArrayElement, writeAttribute, writeAttribute, writeAttribute, writeAttribute, writeEmptyElement, writeEndListElement, writeMapItem, writeMapItem, writeStartArrayElement, writeStartElement, writeStartElement, writeStartListElement, writeStartListElement, writeStartMap
-
-
-
-
Field Detail
-
INDENT
public static final int INDENT
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
YamlConfigurationWriter
public YamlConfigurationWriter(Writer writer, boolean clearTextSecrets)
-
-
Method Detail
-
writeStartDocument
public void writeStartDocument()
-
writeStartElement
public void writeStartElement(String name)
-
writeStartArrayElement
public void writeStartArrayElement(String name)
Description copied from interface:ConfigurationWriter
Writes an array element. This will be treated as follows by the various implementations:- XML <outer></outer>
- YAML
name:
- item1 - item2 - JSON name: [ item1, item2 ]
-
writeEndArrayElement
public void writeEndArrayElement()
-
writeStartListElement
public void writeStartListElement(String name, boolean explicit)
Description copied from interface:ConfigurationWriter
Starts a list element.
-
writeStartListElement
public void writeStartListElement(String prefix, String namespace, String name, boolean explicit)
-
writeDefaultNamespace
public void writeDefaultNamespace(String namespace)
-
writeEndElement
public void writeEndElement()
-
writeEndDocument
public void writeEndDocument()
-
writeArrayElement
public void writeArrayElement(String outer, String inner, String attribute, Iterable<String> values)
-
writeCharacters
public void writeCharacters(String chars)
-
writeEmptyElement
public void writeEmptyElement(String name)
-
writeComment
public void writeComment(String comment)
-
writeStartMap
public void writeStartMap(String name)
-
writeMapItem
public void writeMapItem(String element, String name, String key, String value)
Description copied from interface:ConfigurationWriter
Writes a simple map entry.- XML: <element name="key">value<element>
- JSON: { key: value }
- YAML: key: value
The key name is not translated by the underlying serialization implementation and is used as is
- Parameters:
element
- Used only by XMLname
- Used only by XML
-
writeMapItem
public void writeMapItem(String element, String name, String key)
Description copied from interface:ConfigurationWriter
Writes a complex map entry.- XML: <element name="key">...<element>
- JSON: { key: { ... } }
- YAML: key:
The key name is not translated by the underlying serialization implementation and is used as is
- Parameters:
element
- Used only by XMLname
- Used only by XML
-
writeEndMapItem
public void writeEndMapItem()
-
writeEndMap
public void writeEndMap()
-
hasFeature
public boolean hasFeature(ConfigurationFormatFeature feature)
-
-