net.kyori.xml.document.factory

Interface DocumentFactory

public interface DocumentFactory

A document factory.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentFactory.Builder A document factory builder.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INCLUDE_ELEMENT_NAME The name of the include element.

Method Summary

Modifier and Type	Method and Description
static @NonNull DocumentFactory.Builder	builder() Creates a new builder.
@NonNull org.jdom2.Document	read(@NonNull java.nio.file.Path path) Reads a document.

Field Detail

INCLUDE_ELEMENT_NAME

static final java.lang.String INCLUDE_ELEMENT_NAME

The name of the include element.

See Also:

Constant Field Values

Method Detail

builder

static @NonNull DocumentFactory.Builder builder()

Creates a new builder.

Returns:

a new builder

read

@NonNull org.jdom2.Document read(@NonNull java.nio.file.Path path)
                          throws XMLException

Reads a document.

Parameters:

path - the path

Returns:

the document

Throws:

XMLException - if an exception was encountered while reading

XMLException - if an exception was encountered while parsing