Package org.spongepowered.configurate.xml

Class XmlConfigurationLoader.Builder

java.lang.Object

org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder<XmlConfigurationLoader.Builder,XmlConfigurationLoader>

org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder

Enclosing class:

XmlConfigurationLoader

public static final class XmlConfigurationLoader.Builder
extends AbstractConfigurationLoader.Builder<XmlConfigurationLoader.Builder,XmlConfigurationLoader>

Builds a XmlConfigurationLoader.

This builder supports the following options:

• DEFAULT_TAG_NAME
• INDENT
• WRITE_EXPLICIT_TYPE
• RESOLVE_EXTERNAL_CONTENT
• INCLUDE_XML_DECLARATION

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final net.kyori.option.Option<String>	DEFAULT_TAG_NAME	The default tag name the created loader should use.
static final net.kyori.option.Option<Boolean>	INCLUDE_XML_DECLARATION	Whether an XML declaration should be included as the first line of emitted documents from the created loader.
static final net.kyori.option.Option<Integer>	INDENT	The size of indent (in spaces) the created loader should use.
static final net.kyori.option.Option<Boolean>	RESOLVE_EXTERNAL_CONTENT	Whether externally included content should be resolved in documents read by the created loader.
static final net.kyori.option.OptionSchema	SCHEMA	A schema of options available to configure the XML loader.
static final net.kyori.option.Option<Boolean>	WRITE_EXPLICIT_TYPE	Whether explicit node types should be written out (to disambiguate between maps and lists).

Fields inherited from class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder

defaultOptions, HEADER_MODE, headerMode, sink, source

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
XmlConfigurationLoader	build()	Builds the loader.
@NonNull String	defaultTagName()	Gets the default tag name to be used by the resultant loader.
XmlConfigurationLoader.Builder	defaultTagName(String defaultTagName)	Sets the default tag name the resultant loader should use.
boolean	includesXmlDeclaration()	Gets if the resultant loader should include the XML declaration header when saving.
XmlConfigurationLoader.Builder	includesXmlDeclaration(boolean includeXmlDeclaration)	Sets if the resultant loader should include the XML declaration header when saving.
int	indent()	Gets the level of indentation to be used by the resultant loader.
@NonNull XmlConfigurationLoader.Builder	indent(int indent)	Sets the level of indentation the resultant loader should use.
protected net.kyori.option.OptionSchema	optionSchema()	Get the schema of available options that can be set on this loader.
boolean	resolvesExternalContent()	Get whether external content should be resolved.
XmlConfigurationLoader.Builder	resolvesExternalContent(boolean resolvesExternalContent)	Sets whether external content should be resolved when loading data.
@Nullable Schema	schema()	Gets the Schema to be used by the resultant loader.
XmlConfigurationLoader.Builder	schema(@Nullable Schema schema)	Sets the Schema the resultant loader should use.
boolean	writesExplicitType()	Gets if explicit type attributes should be written by the loader.
XmlConfigurationLoader.Builder	writesExplicitType(boolean writeExplicitType)	Sets if the resultant loader should write the explicit type of each node when saving nodes.

Methods inherited from class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder

buildAndLoadString, buildAndSaveString, defaultOptions, defaultOptions, defaultOptions, editOptions, file, headerMode, headerMode, optionState, optionState, optionStateBuilder, path, sink, sink, source, source, url

Methods inherited from class java.lang.Object

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

Field Details

SCHEMA

public static final net.kyori.option.OptionSchema SCHEMA

A schema of options available to configure the XML loader.

Since:

4.2.0

DEFAULT_TAG_NAME

public static final net.kyori.option.Option<String> DEFAULT_TAG_NAME

The default tag name the created loader should use.

Since:

4.2.0

See Also:

• defaultTagName(String)

INDENT

public static final net.kyori.option.Option<Integer> INDENT

The size of indent (in spaces) the created loader should use.

Since:

4.2.0

See Also:

• indent(int)

WRITE_EXPLICIT_TYPE

public static final net.kyori.option.Option<Boolean> WRITE_EXPLICIT_TYPE

Whether explicit node types should be written out (to disambiguate between maps and lists).

Since:

4.2.0

See Also:

• writesExplicitType(boolean)

RESOLVE_EXTERNAL_CONTENT

public static final net.kyori.option.Option<Boolean> RESOLVE_EXTERNAL_CONTENT

Whether externally included content should be resolved in documents read by the created loader.

Since:

4.2.0

See Also:

• resolvesExternalContent(boolean)

INCLUDE_XML_DECLARATION

public static final net.kyori.option.Option<Boolean> INCLUDE_XML_DECLARATION

Whether an XML declaration should be included as the first line of emitted documents from the created loader.

Since:

4.2.0

See Also:

• includesXmlDeclaration(boolean)

Constructor Details

Builder

public Builder()

Method Details

optionSchema

protected net.kyori.option.OptionSchema optionSchema()

Description copied from class: AbstractConfigurationLoader.Builder

Get the schema of available options that can be set on this loader.

This schema should inherit from AbstractConfigurationLoader.Builder.UNSAFE_SCHEMA.

Overrides:

optionSchema in class AbstractConfigurationLoader.Builder<XmlConfigurationLoader.Builder,XmlConfigurationLoader>

Returns:

the option schema

indent

public @NonNull XmlConfigurationLoader.Builder indent(int indent)

Sets the level of indentation the resultant loader should use.

Parameters:

indent - the indent level

Returns:

this builder (for chaining)

Since:

4.0.0

indent

public int indent()

Gets the level of indentation to be used by the resultant loader.

Returns:

the indent level

Since:

4.0.0

schema

public XmlConfigurationLoader.Builder schema(@Nullable Schema schema)

Sets the Schema the resultant loader should use.

Parameters:

schema - the schema

Returns:

this builder (for chaining)

Since:

4.0.0

schema

public @Nullable Schema schema()

Gets the Schema to be used by the resultant loader.

Returns:

the schema

Since:

4.0.0

defaultTagName

public XmlConfigurationLoader.Builder defaultTagName(String defaultTagName)

Sets the default tag name the resultant loader should use.

Parameters:

defaultTagName - the default tag name

Returns:

this builder (for chaining)

Since:

4.0.0

defaultTagName

public @NonNull String defaultTagName()

Gets the default tag name to be used by the resultant loader.

Returns:

the default tag name

Since:

4.0.0

writesExplicitType

public XmlConfigurationLoader.Builder writesExplicitType(boolean writeExplicitType)

Sets if the resultant loader should write the explicit type of each node when saving nodes.

This is necessary in some cases, as XML has no explicit definition of an array or list. The loader is able to infer the type in some cases, but this is inaccurate in some cases, for example lists with only one element.

Parameters:

writeExplicitType - if the loader should write explicit types

Returns:

this builder (for chaining)

Since:

4.0.0

writesExplicitType

public boolean writesExplicitType()

Gets if explicit type attributes should be written by the loader.

See the method doc at writesExplicitType(boolean) for a more detailed explanation.

Returns:

the default tag name

Since:

4.0.0

includesXmlDeclaration

public XmlConfigurationLoader.Builder includesXmlDeclaration(boolean includeXmlDeclaration)

Sets if the resultant loader should include the XML declaration header when saving.

Parameters:

includeXmlDeclaration - if the XML declaration should be included

Returns:

this builder (for chaining)

Since:

4.0.0

includesXmlDeclaration

public boolean includesXmlDeclaration()

Gets if the resultant loader should include the XML declaration header when saving.

Returns:

if the XML declaration should be included

Since:

4.0.0

resolvesExternalContent

public XmlConfigurationLoader.Builder resolvesExternalContent(boolean resolvesExternalContent)

Sets whether external content should be resolved when loading data.

Resolving this content could result in network requests being made, and will allow configuration files to access arbitrary URLs This setting should only be enabled with caution.

Additionally, through use of features such as entity expansion and XInclude, documents can be crafted that will grow exponentially when parsed, requiring an amount of memory to store that may be greater than what is available for the JVM.

By default, this is false.

Parameters:

resolvesExternalContent - whether to resolve external entities

Returns:

this builder

Since:

4.0.0

resolvesExternalContent

public boolean resolvesExternalContent()

Get whether external content should be resolved.

Returns:

value, defaulting to false

Since:

4.0.0

build

public XmlConfigurationLoader build()

Description copied from class: AbstractConfigurationLoader.Builder

Builds the loader.

Specified by:

build in class AbstractConfigurationLoader.Builder<XmlConfigurationLoader.Builder,XmlConfigurationLoader>

Returns:

a new loader