java.lang.Object
org.jooq.XMLFormat
An XML formatting type, which can be used to configure XML imports / exports.
The type is immutable, meaning calls to setters like header(boolean)
do not modify the original reference, but return a new one instead.
- Author:
- Lukas Eder
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
The format of individual XML records. -
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
format()
The formatting flag.format(boolean newFormat)
The new value for the formatting flag, defaulting tofalse
.int
The global indentation applied on all levels.globalIndent(int newGlobalIndent)
The new global indentation size applied on all levels, defaulting to0
.boolean
header()
The header.header(boolean newHeader)
The new header value, defaulting totrue
.int
indent()
The indentation size per level.indent(int newIndent)
The new indentation size per level value, defaulting to2
.indentString(int level)
Convenience method to get an indentation string at a given level.newline()
The formatting flag.The new newline character, defaulting to\n
.boolean
Whether nestedXML
content should be quoted like a string, or nested into XML formatted output.quoteNested(boolean newQuoteNested)
Whether nestedXML
content should be quoted like a string, or nested into XML formatted output.The record format to be applied, defaulting toXMLFormat.RecordFormat.VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE
.recordFormat(XMLFormat.RecordFormat newRecordFormat)
The record format to be applied, defaulting toXMLFormat.RecordFormat.VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE
.boolean
xmlns()
The xmlns flag.xmlns(boolean newXmlns)
The new value for the xmlns flag, defaulting totrue
.
-
Field Details
-
DEFAULT_FOR_RESULTS
-
DEFAULT_FOR_RECORDS
-
-
Constructor Details
-
XMLFormat
public XMLFormat()
-
-
Method Details
-
xmlns
The new value for the xmlns flag, defaulting totrue
. -
xmlns
public final boolean xmlns()The xmlns flag. -
format
The new value for the formatting flag, defaulting tofalse
. -
format
public final boolean format()The formatting flag. -
newline
The new newline character, defaulting to\n
. -
newline
The formatting flag. -
globalIndent
The new global indentation size applied on all levels, defaulting to0
. -
globalIndent
public final int globalIndent()The global indentation applied on all levels. -
indent
The new indentation size per level value, defaulting to2
. -
indent
public final int indent()The indentation size per level. -
indentString
Convenience method to get an indentation string at a given level. -
header
The new header value, defaulting totrue
.This flag governs whether the
/result/fields element should be generated on export.
This flag is ignored on
Formattable.formatXML(XMLFormat)
and similar methods. -
header
public final boolean header()The header. -
recordFormat
The record format to be applied, defaulting toXMLFormat.RecordFormat.VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE
. -
recordFormat
The record format to be applied, defaulting toXMLFormat.RecordFormat.VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE
. -
quoteNested
Whether nestedXML
content should be quoted like a string, or nested into XML formatted output. -
quoteNested
public final boolean quoteNested()Whether nestedXML
content should be quoted like a string, or nested into XML formatted output.
-