de.larssh.utils.xml.XmlReadingProperty Maven / Gradle / Ivy
// Generated by delombok at Sat Apr 03 10:50:23 UTC 2021
package de.larssh.utils.xml;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.SAXParser;
import org.xml.sax.SAXNotRecognizedException;
import org.xml.sax.SAXNotSupportedException;
import org.xml.sax.XMLReader;
import edu.umd.cs.findbugs.annotations.Nullable;
/**
* Allows reading attributes of {@link DocumentBuilderFactory} and properties of
* {@link SAXParser} and {@link XMLReader} in a typed way.
*
*
* While this class offers read support only, the extended class
* {@link XmlReadingWritableProperty} shall be used for read-write accessible
* properties.
*
* @param the property type
*/
public class XmlReadingProperty {
/**
* Property Name
*/
private final String name;
/**
* Allows the user to retrieve specific attributes on the underlying
* implementation.
*
* @param documentBuilderFactory the document builder factory
* @return the value of the attribute
* @throws IllegalArgumentException thrown if the underlying implementation
* doesn't recognize the attribute.
* @see DocumentBuilderFactory#getAttribute(String)
*/
@Nullable
@SuppressWarnings("unchecked")
public T get(final DocumentBuilderFactory documentBuilderFactory) {
return (T) documentBuilderFactory.getAttribute(getName());
}
/**
* Returns the particular property requested for in the underlying
* implementation of {@link XMLReader}.
*
* @param saxParser the SAX parser
* @return the current value of the property
* @throws SAXNotRecognizedException when the underlying {@link XMLReader} does
* not recognize the property name.
* @throws SAXNotSupportedException when the underlying {@link XMLReader}
* recognizes the property name but doesn't
* support the property.
*
* @see XMLReader#getProperty
*/
@Nullable
@SuppressWarnings("unchecked")
public T get(final SAXParser saxParser) throws SAXNotRecognizedException, SAXNotSupportedException {
return (T) saxParser.getProperty(getName());
}
/**
* Look up the value of a property.
*
*
* It is possible for a {@link 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.
*
*
* {@link XMLReader}s are not required to recognize any specific property names.
*
* @param xmlReader the XML reader
* @return the current value of the property
* @throws SAXNotRecognizedException if the property value can't be assigned or
* retrieved.
* @throws SAXNotSupportedException when {@code xmlReader} recognizes the
* property name but cannot determine its
* value at this time.
*/
@Nullable
@SuppressWarnings("unchecked")
public T get(final XMLReader xmlReader) throws SAXNotRecognizedException, SAXNotSupportedException {
return (T) xmlReader.getProperty(getName());
}
/**
* Property Name
*
* @return the property name
*/
@java.lang.SuppressWarnings("all")
@edu.umd.cs.findbugs.annotations.SuppressFBWarnings(justification = "generated code")
@lombok.Generated
public String getName() {
return this.name;
}
@java.lang.SuppressWarnings("all")
@edu.umd.cs.findbugs.annotations.SuppressFBWarnings(justification = "generated code")
@lombok.Generated
public XmlReadingProperty(final String name) {
this.name = name;
}
}