de.larssh.utils.xml

Class XmlReadingWritableProperty<T>

java.lang.Object

de.larssh.utils.xml.XmlReadingProperty<T>

de.larssh.utils.xml.XmlReadingWritableProperty<T>

Type Parameters:

T - the property type

public class XmlReadingWritableProperty<T>
extends XmlReadingProperty<T>

Allows reading and writing attributes of DocumentBuilderFactory and properties of SAXParser and XMLReader in a typed way.

Constructor Summary

Constructors

Constructor and Description
XmlReadingWritableProperty(String name) Allows reading and writing attributes of DocumentBuilderFactory and properties of XMLReader in a typed way.

Method Summary

Modifier and Type	Method and Description
void	set(DocumentBuilderFactory documentBuilderFactory, T value) Allows the user to set specific attributes on the underlying implementation.
void	set(SAXParser saxParser, T value) Sets the particular property in the underlying implementation of XMLReader.
void	set(XMLReader xmlReader, T value) Set the value of a property.

Methods inherited from class de.larssh.utils.xml.XmlReadingProperty

get, get, get, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlReadingWritableProperty

public XmlReadingWritableProperty(String name)

Allows reading and writing attributes of DocumentBuilderFactory and properties of XMLReader in a typed way.

Parameters:

name - the property name

Method Detail

set

public void set(DocumentBuilderFactory documentBuilderFactory,
                @Nullable
                T value)

Allows the user to set specific attributes on the underlying implementation.

Parameters:

documentBuilderFactory - the document builder factory

value - the value of the attribute

See Also:

DocumentBuilderFactory.setAttribute(String, Object)

set

public void set(SAXParser saxParser,
                @Nullable
                T value)
         throws SAXNotRecognizedException,
                SAXNotSupportedException

Sets the particular property in the underlying implementation of XMLReader. A list of the core features and properties can be found at http://sax.sourceforge.net/?selected=get-set.

Parameters:

saxParser - the SAX parser

value - the value of the property to be set

Throws:

SAXNotRecognizedException - when the underlying XMLReader does not recognize the property name

SAXNotSupportedException - when the underlying XMLReader recognizes the property name but doesn't support the property

See Also:

set(XMLReader, Object)

set

public void set(XMLReader xmlReader,
                @Nullable
                T value)
         throws SAXNotRecognizedException,
                SAXNotSupportedException

Set the value of a property.

It is possible for an XMLReader to recognize a property name but to be unable to change the current value. Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

XMLReaders are not required to recognize setting any specific property names.

Parameters:

xmlReader - the XML reader

value - the requested value for the property

Throws:

SAXNotRecognizedException - if the property value can't be assigned or retrieved

SAXNotSupportedException - when xmlReader recognizes the property name but cannot set the requested value

See Also:

XMLReader.setProperty(String, Object)