Module com.github.ushiosan.jvm

Package com.github.ushiosan23.jvm.xml

Class XMLUtils

java.lang.Object

com.github.ushiosan23.jvm.xml.XMLUtils

public final class XMLUtils
extends Object

Method Summary

Modifier and Type	Method	Description
static @NotNull Validator	generateValidator(@Nullable InputStream schemaValidator, @Nullable String schemaLanguage)	Generates an XML file validator.
static Document	load(@NotNull File location, IApply.EmptyResult<DocumentBuilderFactory> apply)	Load xml file
static @NotNull Document	load(@NotNull InputStream stream, IApply.EmptyResult<DocumentBuilderFactory> apply)	Load xml stream
static Document	load(@NotNull URL location, IApply.EmptyResult<DocumentBuilderFactory> apply)	Load xml url
static Document	load(@NotNull Path location, IApply.EmptyResult<DocumentBuilderFactory> apply)	Load xml file path
static boolean	validate(@NotNull InputStream xml, @Nullable String schemaLanguage, @Nullable InputStream schemaValidator)	Validates an XML file using a schema file.

Methods inherited from class java.lang.Object

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

Method Details

load

public static Document load(@NotNull
 @NotNull File location,
 @Nullable
 IApply.EmptyResult<DocumentBuilderFactory> apply)
                     throws IOException,
ParserConfigurationException,
SAXException

Load xml file

Parameters:

location - The xml location

apply - Action to execute to configure factory instance

Returns:

Returns a document instance

Throws:

IOException - Error to open file

ParserConfigurationException - Error factory configuration

SAXException - Error to parse xml file

load

public static Document load(@NotNull
 @NotNull Path location,
 @Nullable
 IApply.EmptyResult<DocumentBuilderFactory> apply)
                     throws IOException,
ParserConfigurationException,
SAXException

Load xml file path

Parameters:

location - File location

apply - Action to execute to configure factory instance

Returns:

Returns a document instance

Throws:

IOException - Error to open file

ParserConfigurationException - Error factory configuration

SAXException - Error to parse xml file

load

public static Document load(@NotNull
 @NotNull URL location,
 @Nullable
 IApply.EmptyResult<DocumentBuilderFactory> apply)
                     throws IOException,
ParserConfigurationException,
SAXException

Load xml url

Parameters:

location - URL location

apply - Action to execute to configure factory instance

Returns:

Returns a document instance

Throws:

IOException - Error to open file

ParserConfigurationException - Error factory configuration

SAXException - Error to parse xml file

load

@NotNull
public static @NotNull Document load(@NotNull
 @NotNull InputStream stream,
 @Nullable
 IApply.EmptyResult<DocumentBuilderFactory> apply)
                              throws IOException,
ParserConfigurationException,
SAXException

Load xml stream

Parameters:

stream - XML Stream

apply - Action to execute to configure factory instance

Returns:

Returns a document instance

Throws:

IOException - Error to process the stream

ParserConfigurationException - Error factory configuration

SAXException - Error to parse xml file

validate

public static boolean validate(@NotNull
 @NotNull InputStream xml,
 @Nullable
 @Nullable String schemaLanguage,
 @Nullable
 @Nullable InputStream schemaValidator)

Validates an XML file using a schema file.

Parameters:

xml - The XML file you want to validate

schemaLanguage - The validator you want to use. See XMLConstants.W3C_XML_SCHEMA_NS_URI and XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI

schemaValidator - The file containing the validation schema

Returns:

Returns true if the xml file is valid or false if it is invalid or an error has occurred.

generateValidator

@NotNull
public static @NotNull Validator generateValidator(@Nullable
 @Nullable InputStream schemaValidator,
 @Nullable
 @Nullable String schemaLanguage)
                                            throws IOException,
SAXException

Generates an XML file validator.

Parameters:

schemaValidator - XML schema file

schemaLanguage - The validator you want to use. See XMLConstants.W3C_XML_SCHEMA_NS_URI and XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI

Returns:

Returns an instance of Validator configured for use.

Throws:

IOException - IO error

SAXException - If an error occurred during parsing