org.codice.ddf.parser.xml

Class XmlParserConfigurator

java.lang.Object

org.codice.ddf.parser.xml.XmlParserConfigurator

All Implemented Interfaces:

ParserConfigurator

public class XmlParserConfigurator
extends Object
implements ParserConfigurator

Constructor Summary

Constructors

Constructor and Description
XmlParserConfigurator()

Method Summary

Modifier and Type	Method and Description
ParserConfigurator	addProperties(Map<String,Object> properties) Adds a collection of properties with the given key-value mappings for the underlying parser.
ParserConfigurator	addProperty(String key, Object val) Adds a property with the given key and value for the underlying parser to use.
XmlAdapter	getAdapter() Gets XML-specific adapter.
ClassLoader	getClassLoader() Returns the classloader to be used by the underlying parser.
List<String>	getContextPath() Returns the list of paths to be searched for binding information.
ValidationEventHandler	getHandler() Gets XML-specific validation handler.
Map<String,Object>	getProperties() Returns the properties associated with the underlying parser.
ParserConfigurator	setAdapter(XmlAdapter adapter) Sets XML-specific adapter.
ParserConfigurator	setClassLoader(ClassLoader loader) Sets the classloader to be used by underlying implementations.
ParserConfigurator	setContextPath(List contextPath) Sets the list of paths that implementations can search in order to find binding information.
ParserConfigurator	setHandler(ValidationEventHandler handler) Sets XML-specific validation handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlParserConfigurator

public XmlParserConfigurator()

Method Detail

setContextPath

public ParserConfigurator setContextPath(List contextPath)

Description copied from interface: ParserConfigurator

Sets the list of paths that implementations can search in order to find binding information.

Specified by:

setContextPath in interface ParserConfigurator

Parameters:

contextPath - a list of paths that implementations can search in order to find binding information

Returns:

a configuration with the specified context path

getContextPath

public List<String> getContextPath()

Description copied from interface: ParserConfigurator

Returns the list of paths to be searched for binding information.

Specified by:

getContextPath in interface ParserConfigurator

Returns:

the list of paths to be searched for binding information.

setClassLoader

public ParserConfigurator setClassLoader(ClassLoader loader)

Description copied from interface: ParserConfigurator

Sets the classloader to be used by underlying implementations.

Specified by:

setClassLoader in interface ParserConfigurator

Parameters:

loader - the classloader for the parser to use

Returns:

a configuration with the specified classloader

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: ParserConfigurator

Returns the classloader to be used by the underlying parser.

Specified by:

getClassLoader in interface ParserConfigurator

Returns:

the classloader

setHandler

public ParserConfigurator setHandler(ValidationEventHandler handler)

Description copied from interface: ParserConfigurator

Sets XML-specific validation handler.

This is one of two XML-specific settings on the configurator. As XML is a ubiquitous externalizable format, these concessions have been made to provide first-class support to its parsers.

Specified by:

setHandler in interface ParserConfigurator

Parameters:

handler - the validation handler to pass to the underlying parser

Returns:

a configurator with the specified event handler

getHandler

public ValidationEventHandler getHandler()

Description copied from interface: ParserConfigurator

Gets XML-specific validation handler.

Specified by:

getHandler in interface ParserConfigurator

Returns:

the validation handler associated with the underlying parser

setAdapter

public ParserConfigurator setAdapter(XmlAdapter adapter)

Description copied from interface: ParserConfigurator

Sets XML-specific adapter.

This is one of two XML-specific settings on the configurator. As XML is a ubiquitous externalizable format, these concessions have been made to provide first-class support to its parsers.

Specified by:

setAdapter in interface ParserConfigurator

Parameters:

adapter - the adapter to pass to the underlying parser

Returns:

a configurator with the specified adapter

getAdapter

public XmlAdapter getAdapter()

Description copied from interface: ParserConfigurator

Gets XML-specific adapter.

Specified by:

getAdapter in interface ParserConfigurator

Returns:

the adapter associated with the underlying parser

addProperty

public ParserConfigurator addProperty(String key,
                                      Object val)

Description copied from interface: ParserConfigurator

Adds a property with the given key and value for the underlying parser to use.

Specified by:

addProperty in interface ParserConfigurator

Parameters:

key - the unique key for the entry

val - the value of the property

Returns:

a configurator with the specified property set

addProperties

public ParserConfigurator addProperties(Map<String,Object> properties)

Description copied from interface: ParserConfigurator

Adds a collection of properties with the given key-value mappings for the underlying parser.

Specified by:

addProperties in interface ParserConfigurator

Parameters:

properties - a collection of key-value objects to set

Returns:

a configurator with the specified properties set

getProperties

public Map<String,Object> getProperties()

Description copied from interface: ParserConfigurator

Returns the properties associated with the underlying parser.

Specified by:

getProperties in interface ParserConfigurator

Returns:

the associated properties