Interface ConfigurationWriter
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
AbstractConfigurationWriter
,JsonConfigurationWriter
,XmlConfigurationWriter
,YamlConfigurationWriter
public interface ConfigurationWriter extends AutoCloseable
- Since:
- 12.1
- Author:
- Tristan Tarrant <[email protected]>
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ConfigurationWriter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
clearTextSecrets()
void
close()
boolean
hasFeature(ConfigurationFormatFeature feature)
static ConfigurationWriter.Builder
to(OutputStream os)
static ConfigurationWriter.Builder
to(Writer writer)
void
writeArrayElement(Enum<?> outer, Enum<?> inner, Enum<?> attribute, Iterable<String> values)
void
writeArrayElement(String outer, String inner, String attribute, Iterable<String> values)
void
writeAttribute(Enum<?> name, boolean value)
void
writeAttribute(Enum<?> name, Iterable<String> values)
void
writeAttribute(Enum<?> name, String value)
void
writeAttribute(String name, boolean value)
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(Enum<?> name)
void
writeEmptyElement(String name)
void
writeEndArrayElement()
void
writeEndDocument()
void
writeEndElement()
void
writeEndListElement()
void
writeEndMap()
void
writeEndMapItem()
void
writeMapItem(Enum<?> element, Enum<?> name, String key)
void
writeMapItem(Enum<?> element, Enum<?> name, String key, String value)
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(Enum<?> name)
void
writeStartArrayElement(String name)
Writes an array element.void
writeStartDocument()
void
writeStartElement(Enum<?> name)
void
writeStartElement(String name)
void
writeStartElement(String prefix, String namespace, Enum<?> name)
void
writeStartElement(String prefix, String namespace, String name)
void
writeStartListElement(Enum<?> name, boolean explicit)
void
writeStartListElement(String name, boolean explicit)
Starts a list element.void
writeStartListElement(String prefix, String namespace, Enum<?> name, boolean explicit)
void
writeStartListElement(String prefix, String namespace, String name, boolean explicit)
void
writeStartMap(Enum<?> name)
void
writeStartMap(String name)
-
-
-
Method Detail
-
to
static ConfigurationWriter.Builder to(OutputStream os)
-
to
static ConfigurationWriter.Builder to(Writer writer)
-
clearTextSecrets
boolean clearTextSecrets()
-
writeStartDocument
void writeStartDocument()
-
writeStartElement
void writeStartElement(String name)
-
writeStartElement
void writeStartElement(Enum<?> name)
-
writeStartArrayElement
void writeStartArrayElement(String name)
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 ]
- Parameters:
name
-
-
writeStartArrayElement
void writeStartArrayElement(Enum<?> name)
-
writeEndArrayElement
void writeEndArrayElement()
-
writeArrayElement
void writeArrayElement(String outer, String inner, String attribute, Iterable<String> values)
-
writeArrayElement
void writeArrayElement(Enum<?> outer, Enum<?> inner, Enum<?> attribute, Iterable<String> values)
-
writeStartListElement
void writeStartListElement(String name, boolean explicit)
Starts a list element.- Parameters:
name
-explicit
-
-
writeStartListElement
void writeStartListElement(Enum<?> name, boolean explicit)
-
writeStartListElement
void writeStartListElement(String prefix, String namespace, String name, boolean explicit)
-
writeStartListElement
void writeStartListElement(String prefix, String namespace, Enum<?> name, boolean explicit)
-
writeEndListElement
void writeEndListElement()
-
writeStartMap
void writeStartMap(String name)
-
writeStartMap
void writeStartMap(Enum<?> name)
-
writeMapItem
void writeMapItem(String element, String name, String key, String value)
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 XMLkey
-value
-
-
writeMapItem
void writeMapItem(String element, String name, String key)
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 XMLkey
-
-
writeEndMapItem
void writeEndMapItem()
-
writeEndMap
void writeEndMap()
-
writeDefaultNamespace
void writeDefaultNamespace(String namespace)
-
writeEndElement
void writeEndElement()
-
writeEndDocument
void writeEndDocument()
-
writeAttribute
void writeAttribute(Enum<?> name, boolean value)
-
writeAttribute
void writeAttribute(String name, boolean value)
-
writeCharacters
void writeCharacters(String chars)
-
writeEmptyElement
void writeEmptyElement(String name)
-
writeEmptyElement
void writeEmptyElement(Enum<?> name)
-
writeComment
void writeComment(String comment)
-
hasFeature
boolean hasFeature(ConfigurationFormatFeature feature)
-
close
void close()
- Specified by:
close
in interfaceAutoCloseable
-
-