com.mattunderscore.filter.contentnegotiation.variantsource

Class BaseVariantXMLSource

java.lang.Object

com.mattunderscore.filter.contentnegotiation.variantsource.BaseVariantXMLSource

All Implemented Interfaces:

InputStreamVariantSource, VariantSource

public class BaseVariantXMLSource
extends Object
implements InputStreamVariantSource

A variant source that parses XML for variants. It uses SAX to parse the XML. The XML is passed in through an input stream. A SAX handler to use can also be passed in. By default it uses the VariantXMLParser class. This class will try to validate the XML file against the schema.

Since:

0.2.0

Author:

Matt Champion

Constructor Summary

Constructors

Constructor and Description
BaseVariantXMLSource()
BaseVariantXMLSource(VariantSAXHandler parser)

Method Summary

Modifier and Type	Method and Description
List<Variant>	getVariants() Get the variants from the variant source.
void	setHandler(VariantSAXHandler handler) Setter for the SAX handler.
void	setInputStream(InputStream inputStream) Setter for the input stream that provides the description of the variants.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseVariantXMLSource

public BaseVariantXMLSource()

BaseVariantXMLSource

public BaseVariantXMLSource(VariantSAXHandler parser)

Method Detail

setHandler

public void setHandler(VariantSAXHandler handler)

Setter for the SAX handler.

Parameters:

handler - The SAX handler

Since:

0.2.0

getVariants

public List<Variant> getVariants()
                          throws VariantSourceException

Description copied from interface: VariantSource

Get the variants from the variant source. The variants are returned a list.

Specified by:

getVariants in interface VariantSource

Returns:

A list of the variants defined by the variant source

Throws:

VariantSourceException - Thrown when unable to return the variants

VariantSourceConfigurationException - Thrown when the variant source is not configured

setInputStream

public void setInputStream(InputStream inputStream)

Description copied from interface: InputStreamVariantSource

Setter for the input stream that provides the description of the variants.

Specified by:

setInputStream in interface InputStreamVariantSource

Parameters:

inputStream - The input stream