org.opensaml.xml.parse
Interface ParserPool

All Known Implementing Classes:

BasicParserPool, StaticBasicParserPool

public interface ParserPool

A pool of XML parsers.

Method Summary

javax.xml.parsers.DocumentBuilder	getBuilder() Gets a builder from the pool.
javax.xml.validation.Schema	getSchema() Gets the schema builders use to validate.
org.w3c.dom.Document	newDocument() Convience method for creating a new document with a pooled builder.
org.w3c.dom.Document	parse(java.io.InputStream input) Convience method for parsing an XML file using a pooled builder.
org.w3c.dom.Document	parse(java.io.Reader input) Convience method for parsing an XML file using a pooled builder.
void	returnBuilder(javax.xml.parsers.DocumentBuilder builder) Returns a builder to the pool.
void	setSchema(javax.xml.validation.Schema newSchema) Sets the schema builders use to validate.

Method Detail

getBuilder

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(javax.xml.parsers.DocumentBuilder builder)

Returns a builder to the pool.

Parameters:

builder - the builder to return

newDocument

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

Convience 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

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

Convience 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

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

Convience 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

getSchema

javax.xml.validation.Schema getSchema()

Gets the schema builders use to validate.

Returns:

the schema builders use to validate

setSchema

void setSchema(javax.xml.validation.Schema newSchema)

Sets the schema builders use to validate.

Parameters:

newSchema - the schema builders use to validate