net.shibboleth.utilities.java.support.xml

Interface ParserPool

All Known Implementing Classes:

BasicParserPool

public interface ParserPool

A pool of XML parsers.

Method Summary

Modifier and Type	Method and Description
javax.xml.parsers.DocumentBuilder	getBuilder() Gets a builder from the pool.
org.w3c.dom.Document	newDocument() Convenience method for creating a new document with a pooled builder.
org.w3c.dom.Document	parse(java.io.InputStream input) Convenience method for parsing an XML file using a pooled builder.
org.w3c.dom.Document	parse(java.io.Reader input) Convenience method for parsing an XML file using a pooled builder.
void	returnBuilder(javax.xml.parsers.DocumentBuilder builder) Returns a builder to the pool.

Method Detail

getBuilder

@Nonnull
javax.xml.parsers.DocumentBuilder getBuilder()
                                               throws XMLParserException

Gets a builder from the pool.

Returns:

a builder from the pool

Throws:

XMLParserException - thrown if the document builder factory is misconfigured

returnBuilder

void returnBuilder(@Nullable
                   javax.xml.parsers.DocumentBuilder builder)

Returns a builder to the pool.

Parameters:

builder - the builder to return

newDocument

@Nonnull
org.w3c.dom.Document newDocument()
                                   throws XMLParserException

Convenience method for creating a new document with a pooled builder.

Returns:

created document

Throws:

XMLParserException - thrown if there is a problem retrieving a builder

parse

@Nonnull
org.w3c.dom.Document parse(@Nonnull
                                    java.io.InputStream input)
                             throws XMLParserException

Convenience method for parsing an XML file using a pooled builder.

Parameters:

input - XML to parse

Returns:

parsed document

Throws:

XMLParserException - thrown if there is a problem retrieving a builder, the input stream can not be read, or the XML was invalid

parse

@Nonnull
org.w3c.dom.Document parse(@Nonnull
                                    java.io.Reader input)
                             throws XMLParserException

Convenience method for parsing an XML file using a pooled builder.

Parameters:

input - XML to parse

Returns:

parsed document

Throws:

XMLParserException - thrown if there is a problem retrieving a builder, the input stream can not be read, or the XML was invalid