de.larssh.utils.xml

Class XmlReadingProperty<T>

java.lang.Object

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

Type Parameters:

T - the property type

Direct Known Subclasses:

XmlReadingWritableProperty

public class XmlReadingProperty<T>
extends Object

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

While this class offers read support only, the extended class XmlReadingWritableProperty shall be used for read-write accessible properties.

Constructor Summary

Constructors

Constructor and Description
XmlReadingProperty(String name) Creates a new XmlReadingProperty instance.

Method Summary

Modifier and Type	Method and Description
T	get(DocumentBuilderFactory documentBuilderFactory) Allows the user to retrieve specific attributes on the underlying implementation.
T	get(SAXParser saxParser) Returns the particular property requested for in the underlying implementation of XMLReader.
T	get(XMLReader xmlReader) Look up the value of a property.
String	getName() Property Name

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlReadingProperty

public XmlReadingProperty(String name)

Creates a new XmlReadingProperty instance.

Parameters:

name - Property Name

Method Detail

get

@Nullable
public T get(DocumentBuilderFactory documentBuilderFactory)

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

Parameters:

documentBuilderFactory - the document builder factory

Returns:

the value of the attribute

Throws:

IllegalArgumentException - thrown if the underlying implementation doesn't recognize the attribute.

See Also:

DocumentBuilderFactory.getAttribute(String)

get

@Nullable
public T get(SAXParser saxParser)
                throws SAXNotRecognizedException,
                       SAXNotSupportedException

Returns the particular property requested for in the underlying implementation of XMLReader.

Parameters:

saxParser - the SAX parser

Returns:

the current value of the property

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:

XMLReader.getProperty(java.lang.String)

get

@Nullable
public T get(XMLReader xmlReader)
                throws SAXNotRecognizedException,
                       SAXNotSupportedException

Look up the value of a property.

It is possible for a XMLReader to recognize a property name but temporarily be unable to return its value. Some property values may be available only in specific contexts, such as before, during, or after a parse.

XMLReaders are not required to recognize any specific property names.

Parameters:

xmlReader - the XML reader

Returns:

the current value of the property

Throws:

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

SAXNotSupportedException - when xmlReader recognizes the property name but cannot determine its value at this time.

getName

public String getName()

Property Name

Returns:

the property name