Module org.jhotdraw8.xml

Package org.jhotdraw8.xml

Class XmlUtil

java.lang.Object

org.jhotdraw8.xml.XmlUtil

public class XmlUtil
extends Object

XmlUtil.

Author:

Werner Randelshofer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CANONICAL_LINE_SEPARATOR
static final String	HTTP_XML_APACHE_ORG_XALAN_LINE_SEPARATOR
static final String	HTTP_XML_APACHE_ORG_XSLT_INDENT_AMOUNT
static final String	LOCATION_ATTRIBUTE
static final String	LOCATION_NAMESPACE

Method Summary

Modifier and Type	Method	Description
static Document	createDocument(@Nullable String nsURI, @Nullable String nsQualifier, String docElemName)	Creates a namespace aware document.
static @Nullable Locator	getLocator(@NonNull Node node)
static Document	read(InputStream in, boolean namespaceAware)
static Document	read(Reader in, boolean namespaceAware)
static Document	read(@NonNull Path in, boolean namespaceAware)
static Document	read(InputSource inputSource, boolean namespaceAware)
static @Nullable String	readNamespaceUri(@NonNull URI file)
static @Nullable String	readNamespaceUri(@NonNull Source source)
static @NonNull Document	readWithLocations(@NonNull Path in, boolean namespaceAware)
static @NonNull Document	readWithLocations(InputSource inputSource, boolean namespaceAware)	Reads the specified input into a document.
static XMLStreamReader	streamReader(@NonNull Source file)	Creates an XMLStreamReader that only reads data from the specified file.
static XMLStreamWriter	streamWriter(@NonNull Result file, @Nullable Properties outputProperties)	Creates an XMLStreamWriter that only writes data to the specified file.
static void	validate(@NonNull URI xmlUri, @NonNull URI schemaUri)
static void	validate(@NonNull Path xmlPath, @NonNull URI schemaUri)
static void	validate(@NonNull Source docSource, @NonNull Source schemaSource)
static void	validate(@NonNull Document doc, @NonNull URI schemaUri)
static void	validate(@NonNull Document doc, @NonNull URL schemaUrl)
static void	write(OutputStream out, Document doc)
static void	write(Writer out, Document doc)
static void	write(@NonNull Path out, Document doc)
static void	write(@NonNull Path out, Document doc, Properties outputProperties)
static void	write(@NonNull Result result, @NonNull Document doc)
static void	write(@NonNull Result result, @NonNull Document doc, @Nullable Properties outputProperties)

Methods inherited from class java.lang.Object

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

Field Details

LOCATION_ATTRIBUTE

public static final String LOCATION_ATTRIBUTE

See Also:

• Constant Field Values

LOCATION_NAMESPACE

public static final String LOCATION_NAMESPACE

See Also:

• Constant Field Values

HTTP_XML_APACHE_ORG_XALAN_LINE_SEPARATOR

public static final String HTTP_XML_APACHE_ORG_XALAN_LINE_SEPARATOR

See Also:

• Constant Field Values

HTTP_XML_APACHE_ORG_XSLT_INDENT_AMOUNT

public static final String HTTP_XML_APACHE_ORG_XSLT_INDENT_AMOUNT

See Also:

• Constant Field Values

CANONICAL_LINE_SEPARATOR

public static final String CANONICAL_LINE_SEPARATOR

See Also:

• Constant Field Values

Method Details

createDocument

public static Document createDocument(@Nullable String nsURI,
 @Nullable String nsQualifier,
 String docElemName)
                               throws IOException

Creates a namespace aware document.

Parameters:

nsURI - nullable namespace URI

nsQualifier - nullable namespace qualifier

docElemName - notnull name of the document element

Returns:

a new Document

Throws:

IOException - if the parser configuration fails

read

public static Document read(Reader in,
 boolean namespaceAware)
                     throws IOException

Throws:

IOException

read

public static Document read(InputStream in,
 boolean namespaceAware)
                     throws IOException

Throws:

IOException

read

public static Document read(@NonNull Path in,
 boolean namespaceAware)
                     throws IOException

Throws:

IOException

readWithLocations

public static @NonNull Document readWithLocations(@NonNull Path in,
 boolean namespaceAware)
                                           throws IOException

Throws:

IOException

read

public static Document read(InputSource inputSource,
 boolean namespaceAware)
                     throws IOException

Throws:

IOException

readWithLocations

public static @NonNull Document readWithLocations(InputSource inputSource,
 boolean namespaceAware)
                                           throws IOException

Reads the specified input into a document. Adds a "location" attribute to each node, specifying the file, the line number and the column number of the node.

References:

Stackoverflow, Is there a way to parse XML via SAX/DOM with line numbers available per node, Copyright Reg Whitton, CC BY-SA 4.0 license

stackoverflow.com.

Parameters:

inputSource - the input source

namespaceAware - whether to be name space aware

Returns:

the document

Throws:

IOException - in case of failure

getLocator

public static @Nullable Locator getLocator(@NonNull Node node)

validate

public static void validate(@NonNull Document doc,
 @NonNull URI schemaUri)
                     throws IOException

Throws:

IOException

validate

public static void validate(@NonNull Document doc,
 @NonNull URL schemaUrl)
                     throws IOException

Throws:

IOException

validate

public static void validate(@NonNull Source docSource,
 @NonNull Source schemaSource)
                     throws IOException

Throws:

IOException

validate

public static void validate(@NonNull Path xmlPath,
 @NonNull URI schemaUri)
                     throws IOException

Throws:

IOException

validate

public static void validate(@NonNull URI xmlUri,
 @NonNull URI schemaUri)
                     throws IOException

Throws:

IOException

write

public static void write(OutputStream out,
 Document doc)
                  throws IOException

Throws:

IOException

write

public static void write(Writer out,
 Document doc)
                  throws IOException

Throws:

IOException

write

public static void write(@NonNull Path out,
 Document doc)
                  throws IOException

Throws:

IOException

write

public static void write(@NonNull Path out,
 Document doc,
 Properties outputProperties)
                  throws IOException

Throws:

IOException

write

public static void write(@NonNull Result result,
 @NonNull Document doc)
                  throws IOException

Throws:

IOException

write

public static void write(@NonNull Result result,
 @NonNull Document doc,
 @Nullable Properties outputProperties)
                  throws IOException

Throws:

IOException

streamWriter

public static XMLStreamWriter streamWriter(@NonNull Result file,
 @Nullable Properties outputProperties)

Creates an XMLStreamWriter that only writes data to the specified file. That is, it does not create socket connections.

Parameters:

file - a file

Returns:

an XMLStreamWriter

streamReader

public static XMLStreamReader streamReader(@NonNull Source file)
                                    throws XMLStreamException

Creates an XMLStreamReader that only reads data from the specified file. That is, it does not create socket connections.

Parameters:

file - a file

Returns:

an XMLStreamReader

Throws:

XMLStreamException - when the XMLStreamReader could not be created

readNamespaceUri

public static @Nullable String readNamespaceUri(@NonNull URI file)
                                         throws IOException

Throws:

IOException

readNamespaceUri

public static @Nullable String readNamespaceUri(@NonNull Source source)
                                         throws IOException

Throws:

IOException