Class XMLIndentingStreamWriter

A XMLIndentingStreamWriter writes the XML output formatted for good readability.

Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.

Property Summary 

PropertyDescription
indent: StringReturns the indent.
newLine: StringReturns the string that is used for a new line character.

Constructor Summary 

ConstructorDescription
XMLIndentingStreamWriter(Writer)Constructs the writer for the specified writer.

Method Summary 

MethodDescription
getIndent()Returns the indent.
getNewLine()Returns the string that is used for a new line character.
setIndent(String)Specifies a string that will be used as identing characters.
setNewLine(String)Sets the string that is used for a new line character.

Methods inherited from class XMLStreamWriter 

close, flush, getDefaultNamespace, getPrefix, setDefaultNamespace, setPrefix, writeAttribute, writeAttribute, writeAttribute, writeCData, writeCharacters, writeComment, writeDTD, writeDefaultNamespace, writeEmptyElement, writeEmptyElement, writeEmptyElement, writeEndDocument, writeEndElement, writeEntityRef, writeNamespace, writeProcessingInstruction, writeProcessingInstruction, writeRaw, writeStartDocument, writeStartDocument, writeStartDocument, writeStartElement, writeStartElement, writeStartElement

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

indent 

indent: String

Returns the indent.


newLine 

newLine: String

Returns the string that is used for a new line character. The default is the normal new line character.


Constructor Details 

XMLIndentingStreamWriter(Writer) 

XMLIndentingStreamWriter(writer: Writer)

Constructs the writer for the specified writer.

Parameters:

  • writer - the writer to use.

Method Details 

getIndent() 

getIndent(): String

Returns the indent.

Returns:

  • Returns the indent.

getNewLine() 

getNewLine(): String

Returns the string that is used for a new line character. The default is the normal new line character.

Returns:

  • the new line.

setIndent(String) 

setIndent(indent: String): void

Specifies a string that will be used as identing characters. The default are two space characters.

Parameters:

  • indent - The indent to set.

setNewLine(String) 

setNewLine(newLine: String): void

Sets the string that is used for a new line character.

Parameters:

  • newLine - The newLine to set.