Modifier and Type	Class and Description
public static enum	XMLFormat.RecordFormat The format of individual XML records.

Modifier and Type	Field and Description
public static final XMLFormat	DEFAULT_FOR_RECORDS
public static final XMLFormat	DEFAULT_FOR_RESULTS
pack-priv boolean	format
pack-priv int	globalIndent
pack-priv boolean	header
pack-priv int	indent
pack-priv String[]	indented
pack-priv final boolean	mutable
pack-priv String	newline
pack-priv boolean	quoteNested
pack-priv XMLFormat.RecordFormat	recordFormat
pack-priv boolean	xmlns

Access	Constructor and Description
public	XMLFormat()
private	XMLFormat(boolean mutable, boolean xmlns, boolean format, String newline, int globalIndent, int indent, String[] indented, boolean header, XMLFormat.RecordFormat recordFormat, boolean quoteNested)

Method Summary

Modifier and Type	Method and Description
public final @NotNull XMLFormat	format(boolean newFormat) The new value for the formatting flag, defaulting to `false`.
public final boolean	format() The formatting flag.
public final @NotNull XMLFormat	globalIndent(int newGlobalIndent) The new global indentation size applied on all levels, defaulting to `0`.
public final int	globalIndent() The global indentation applied on all levels.
public final @NotNull XMLFormat	header(boolean newHeader) The new header value, defaulting to `true`.
public final boolean	header() The header.
public final @NotNull XMLFormat	indent(int newIndent) The new indentation size per level value, defaulting to `2`.
public final int	indent() The indentation size per level.
public final @NotNull String	indentString(int level) Convenience method to get an indentation string at a given level.
public final boolean	mutable() Whether this configuration object is mutable.
public final @NotNull XMLFormat	mutable(boolean newMutable) The new value for the mutable flag, defaulting to `false`.
public final @NotNull XMLFormat	newline(String newNewline) The new newline character, defaulting to `\n`.
public final @NotNull String	newline() The formatting flag.
public final @NotNull XMLFormat	quoteNested(boolean newQuoteNested) Whether nested `XML` content should be quoted like a string, or nested into XML formatted output.
public final boolean	quoteNested() Whether nested `XML` content should be quoted like a string, or nested into XML formatted output.
public final @NotNull XMLFormat	recordFormat(XMLFormat.RecordFormat newRecordFormat) The record format to be applied, defaulting to `RecordFormat#VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE`.
public final @NotNull XMLFormat.RecordFormat	recordFormat() The record format to be applied, defaulting to `RecordFormat#VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE`.
public final @NotNull XMLFormat	xmlns(boolean newXmlns) The new value for the xmlns flag, defaulting to `true`.
public final boolean	xmlns() The xmlns flag.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_FOR_RECORDS	back to summary
public static final XMLFormat DEFAULT_FOR_RECORDS

DEFAULT_FOR_RESULTS	back to summary
public static final XMLFormat DEFAULT_FOR_RESULTS

format	back to summary
pack-priv boolean format

globalIndent	back to summary
pack-priv int globalIndent

header	back to summary
pack-priv boolean header

indent	back to summary
pack-priv int indent

indented	back to summary
pack-priv String[] indented

mutable	back to summary
pack-priv final boolean mutable

newline	back to summary
pack-priv String newline

quoteNested	back to summary
pack-priv boolean quoteNested

recordFormat	back to summary
pack-priv XMLFormat.RecordFormat recordFormat

xmlns	back to summary
pack-priv boolean xmlns

Constructor Detail

XMLFormat	back to summary
public XMLFormat()

XMLFormat	back to summary
private XMLFormat(boolean mutable, boolean xmlns, boolean format, String newline, int globalIndent, int indent, String[] indented, boolean header, XMLFormat.RecordFormat recordFormat, boolean quoteNested)

Method Detail

format back to summary

format	back to summary
public final @NotNull XMLFormat format(boolean newFormat) The new value for the formatting flag, defaulting to `false`. Annotations @NotNull

public final @NotNull XMLFormat format(boolean newFormat)

The new value for the formatting flag, defaulting to false.

Annotations

@NotNull

format	back to summary
public final boolean format() The formatting flag.

globalIndent back to summary

globalIndent	back to summary
public final @NotNull XMLFormat globalIndent(int newGlobalIndent) The new global indentation size applied on all levels, defaulting to `0`. Annotations @NotNull

public final @NotNull XMLFormat globalIndent(int newGlobalIndent)

The new global indentation size applied on all levels, defaulting to 0.

Annotations

@NotNull

globalIndent	back to summary
public final int globalIndent() The global indentation applied on all levels.

header back to summary

header	back to summary
public final @NotNull XMLFormat header(boolean newHeader) The new header value, defaulting to `true`. This flag governs whether the `/result/fields` element should be generated on export. This flag is ignored on `Record#formatXML(XMLFormat)` and similar methods. Annotations @NotNull

public final @NotNull XMLFormat header(boolean newHeader)

The new header value, defaulting to true.

This flag governs whether the /result/fields element should be generated on export.

This flag is ignored on Record#formatXML(XMLFormat) and similar methods.

Annotations

@NotNull

header	back to summary
public final boolean header() The header.

indent back to summary

indent	back to summary
public final @NotNull XMLFormat indent(int newIndent) The new indentation size per level value, defaulting to `2`. Annotations @NotNull

public final @NotNull XMLFormat indent(int newIndent)

The new indentation size per level value, defaulting to 2.

Annotations

@NotNull

indent	back to summary
public final int indent() The indentation size per level.

indentString	back to summary
public final @NotNull String indentString(int level) Convenience method to get an indentation string at a given level. Annotations @NotNull

indentString

back to summary

public final @NotNull String indentString(int level)

Convenience method to get an indentation string at a given level.

Annotations

@NotNull

mutable	back to summary
public final boolean mutable() Whether this configuration object is mutable.

mutable back to summary

mutable	back to summary
public final @NotNull XMLFormat mutable(boolean newMutable) The new value for the mutable flag, defaulting to `false`. Annotations @NotNull

public final @NotNull XMLFormat mutable(boolean newMutable)

The new value for the mutable flag, defaulting to false.

Annotations

@NotNull

newline back to summary

newline	back to summary
public final @NotNull XMLFormat newline(String newNewline) The new newline character, defaulting to `\n`. Annotations @NotNull

public final @NotNull XMLFormat newline(String newNewline)

The new newline character, defaulting to \n.

Annotations

@NotNull

newline	back to summary
public final @NotNull String newline() The formatting flag. Annotations @NotNull

newline

back to summary

public final @NotNull String newline()

The formatting flag.

Annotations

@NotNull

quoteNested back to summary

quoteNested	back to summary
public final @NotNull XMLFormat quoteNested(boolean newQuoteNested) Whether nested `XML` content should be quoted like a string, or nested into XML formatted output. Annotations @NotNull

public final @NotNull XMLFormat quoteNested(boolean newQuoteNested)

Whether nested XML content should be quoted like a string, or nested into XML formatted output.

Annotations

@NotNull

quoteNested	back to summary
public final boolean quoteNested() Whether nested `XML` content should be quoted like a string, or nested into XML formatted output.

recordFormat back to summary

recordFormat	back to summary
public final @NotNull XMLFormat recordFormat(XMLFormat.RecordFormat newRecordFormat) The record format to be applied, defaulting to `RecordFormat#VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE`. Annotations @NotNull

public final @NotNull XMLFormat recordFormat(XMLFormat.RecordFormat newRecordFormat)

The record format to be applied, defaulting to RecordFormat#VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE.

Annotations

@NotNull

recordFormat back to summary

recordFormat	back to summary
public final @NotNull XMLFormat.RecordFormat recordFormat() The record format to be applied, defaulting to `RecordFormat#VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE`. Annotations @NotNull

public final @NotNull XMLFormat.RecordFormat recordFormat()

The record format to be applied, defaulting to RecordFormat#VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE.

Annotations

@NotNull

xmlns back to summary

xmlns	back to summary
public final @NotNull XMLFormat xmlns(boolean newXmlns) The new value for the xmlns flag, defaulting to `true`. Annotations @NotNull

public final @NotNull XMLFormat xmlns(boolean newXmlns)

The new value for the xmlns flag, defaulting to true.

Annotations

@NotNull

xmlns	back to summary
public final boolean xmlns() The xmlns flag.

org.jooq back to summary

public final Enum XMLFormat.RecordFormat

Class Inheritance

extends Enum<XMLFormat.RecordFormat>

java.lang.Object
java.lang.Enum
org.jooq.XMLFormat.RecordFormat

The format of individual XML records.

Field Summary

Modifier and Type	Field and Description
public static final XMLFormat.RecordFormat	COLUMN_NAME_ELEMENTS Simplified: `/record/colname/text()`.
public static final XMLFormat.RecordFormat	VALUE_ELEMENTS Simplified: `/record/value/text()`.
public static final XMLFormat.RecordFormat	VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE The default: `/record/value[@field="colname"]/text()`.

Constructor Summary

Access	Constructor and Description
private	RecordFormat()

Method Summary

Modifier and Type	Method and Description
public static XMLFormat.RecordFormat	valueOf(String name)
public static XMLFormat.RecordFormat[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COLUMN_NAME_ELEMENTS	back to summary
public static final XMLFormat.RecordFormat COLUMN_NAME_ELEMENTS Simplified: `/record/colname/text()`.

VALUE_ELEMENTS	back to summary
public static final XMLFormat.RecordFormat VALUE_ELEMENTS Simplified: `/record/value/text()`.

VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE	back to summary
public static final XMLFormat.RecordFormat VALUE_ELEMENTS_WITH_FIELD_ATTRIBUTE The default: `/record/value[@field="colname"]/text()`.

Constructor Detail

RecordFormat	back to summary
private RecordFormat()

Method Detail

valueOf	back to summary
public static XMLFormat.RecordFormat valueOf(String name)

values	back to summary
public static XMLFormat.RecordFormat[] values()

public final Class XMLFormat

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum XMLFormat.RecordFormat

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail