Module org.tquadrat.foundation.xml

Package org.tquadrat.foundation.xml.stringconverter

Class DocumentStringConverter

java.lang.Object

org.tquadrat.foundation.xml.stringconverter.DocumentStringConverter

All Implemented Interfaces:

Serializable, StringConverter<Document>

@ClassVersion(sourceVersion="$Id: DocumentStringConverter.java 1072 2023-09-30 20:44:38Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public final class DocumentStringConverter
extends Object
implements StringConverter<Document>

An implementation of StringConverter for Document values.

The method fromString(CharSequence) parses the input to a document, using the default DocumentBuilderFactory to get a DocumentBuilder.

toString(Document) uses an instance of Transformer to get a String from the document.

Note:

• When converting a String to an instance of Document back to a String, the final String may be different from the input because the formatting can differ, and some implicit defaults will now be provided as explicit setting. Only the semantics are guaranteed to be still the same.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: DocumentStringConverter.java 1072 2023-09-30 20:44:38Z tquadrat $

Since:

0.1.0

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.xml.stringconverter.DocumentStringConverter"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final DocumentStringConverter	INSTANCE	An instance of this class.
static final String	MSG_InvalidXML	The error message for an invalid XML contents: "Invalid XML: %1$s".

Fields inherited from interface org.tquadrat.foundation.lang.StringConverter

METHOD_NAME_GetSubjectClass, METHOD_NAME_Provider

Constructor Summary

Constructors

Constructor	Description
DocumentStringConverter()	Creates a new DocumentStringConverter instance.

Method Summary

Modifier and Type	Method	Description
final Document	fromString(CharSequence source)
final Collection<Class<? extends Document>>	getSubjectClass()	Provides the subject class for this converter.
static final DocumentStringConverter	provider()	This method is used by the ServiceLoader to obtain the instance for this StringConverter implementation.
final String	toString(Document source)

Methods inherited from class java.lang.Object

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

Field Details

MSG_InvalidXML

public static final String MSG_InvalidXML

The error message for an invalid XML contents: "Invalid XML: %1$s".

See Also:

• Constant Field Values

INSTANCE

public static final DocumentStringConverter INSTANCE

An instance of this class.

Constructor Details

DocumentStringConverter

public DocumentStringConverter()

Creates a new DocumentStringConverter instance.

Method Details

fromString

public final Document fromString(CharSequence source)
                          throws IllegalArgumentException

Specified by:

fromString in interface StringConverter<Document>

Throws:

IllegalArgumentException

getSubjectClass

public final Collection<Class<? extends Document>> getSubjectClass()

Provides the subject class for this converter.

Returns:

The subject class.

provider

public static final DocumentStringConverter provider()

This method is used by the ServiceLoader to obtain the instance for this StringConverter implementation.

Returns:

The instance for this StringConverter implementation.

toString

public final String toString(Document source)

Specified by:

toString in interface StringConverter<Document>