foundation.fluent.api.xml

Class DocumentWriterConfig

java.lang.Object

foundation.fluent.api.xml.DocumentWriterConfig

public final class DocumentWriterConfig
extends Object

Configuration of the document writer. It allows one to configure the writer using fluent API, so you specify the config simply like: config().singleQuoteValue().indentSpaces(4) The config is immutable, so every method creates new config instance with immutable parameters.

Field Summary

Fields

Modifier and Type	Field and Description
String	attributeIndent
String	attrQuot
String	indent
String	prettyPrint

Method Summary

Modifier and Type	Method and Description
static DocumentWriterConfig	config() Public factory method to create new config.
DocumentWriterConfig	doubleQuoteValue() Quote attribute values using double quote: `"` This is the default for new config.
DocumentWriterConfig	indentAttribute(int level) Set indentation for attributes.
DocumentWriterConfig	indentSpaces(int level) Set indentation to specified number of spaces.
DocumentWriterConfig	indentTabs() Set indentation to tabs.
DocumentWriterConfig	indentTabs(int level) Set indentation to specified number of tabs.
DocumentWriterConfig	singleQuoteValue() Quote attribute values using single quote (apostrophe): `'`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

attrQuot

public final String attrQuot

prettyPrint

public final String prettyPrint

indent

public final String indent

attributeIndent

public final String attributeIndent

Method Detail

config

public static DocumentWriterConfig config()

Public factory method to create new config.

Returns:

New DocumentWriterConfig instance.

singleQuoteValue

public DocumentWriterConfig singleQuoteValue()

Quote attribute values using single quote (apostrophe): `'`

Returns:

Config with previous values and quoting character changed to apostrophe.

doubleQuoteValue

public DocumentWriterConfig doubleQuoteValue()

Quote attribute values using double quote: `"` This is the default for new config.

Returns:

Config with previous values and quoting character changed to double quote.

indentSpaces

public DocumentWriterConfig indentSpaces(int level)

Set indentation to specified number of spaces. It enables pretty printing, so every tag starts at new line (default behavior is not to do so). Every tag or other content will also get indented by parent prefix + specified number of spaces.

Parameters:

level - Number of spaces to be used to indent.

Returns:

Config with previous values and pretty printing enabled with specified indentation level.

indentTabs

public DocumentWriterConfig indentTabs(int level)

Set indentation to specified number of tabs. It enables pretty printing, so every tag starts at new line (default behavior is not to do so). Every tag or other content will also get indented by parent prefix + specified number of tabs.

Parameters:

level - Number of tabs to be used to indent.

Returns:

Config with previous values and pretty printing enabled with specified indentation level.

indentTabs

public DocumentWriterConfig indentTabs()

Set indentation to tabs. It enables pretty printing, so every tag starts at new line (default behavior is not to do so). Every tag or other content will also get indented by parent prefix + additional tab.

Returns:

Config with previous values and pretty printing enabled with specified indentation.

indentAttribute

public DocumentWriterConfig indentAttribute(int level)

Set indentation for attributes. It's not yet working, and may change similarly to content indentation (only set level).

Parameters:

level - Level of additional attribute indentation.

Returns:

Config with previous values and attribute indentation set.