A B C D E F G H I J L N O P R S T U V W X 

A

AbstractFunction<T> - Class in net.sf.practicalxml.xpath
A base class for writing XPath functions, using a "template method" approach.
AbstractFunction(String, String) - Constructor for class net.sf.practicalxml.xpath.AbstractFunction
Constructor for a function that can take any number of arguments.
AbstractFunction(String, String, int) - Constructor for class net.sf.practicalxml.xpath.AbstractFunction
Constructor for a function that has a fixed number of arguments.
AbstractFunction(String, String, int, int) - Constructor for class net.sf.practicalxml.xpath.AbstractFunction
Constructor for a function that has a variable number of arguments.
AbstractFunction(QName, int, int) - Constructor for class net.sf.practicalxml.xpath.AbstractFunction
Base constructor.
AbstractStringFunction - Class in net.sf.practicalxml.xpath
A base class for writing XPath functions that work with string data.
AbstractStringFunction(String, String) - Constructor for class net.sf.practicalxml.xpath.AbstractStringFunction
Constructor for a function that takes a single argumment.
AbstractStringFunction(String, String, int) - Constructor for class net.sf.practicalxml.xpath.AbstractStringFunction
Constructor for a function that has a fixed number of arguments.
AbstractStringFunction(String, String, int, int) - Constructor for class net.sf.practicalxml.xpath.AbstractStringFunction
Constructor for a function that has a variable number of arguments.
addChild(Node) - Method in class net.sf.practicalxml.builder.ElementNode
Adds a child node -- of any type -- to this element.
addFunction(FunctionResolver.SelfDescribingFunction) - Method in class net.sf.practicalxml.xpath.FunctionResolver
Adds an instance of of #SelfDescribingFunction to this resolver.
addFunction(XPathFunction, QName) - Method in class net.sf.practicalxml.xpath.FunctionResolver
Adds a normal XPathFunction to this resolver, without specifying argument count.
addFunction(XPathFunction, QName, int) - Method in class net.sf.practicalxml.xpath.FunctionResolver
Adds a normal XPathFunction to this resolver.
addFunction(XPathFunction, QName, int, int) - Method in class net.sf.practicalxml.xpath.FunctionResolver
Adds a normal XPathFunction to this resolver.
addNamespace(String, String) - Method in class net.sf.practicalxml.xpath.NamespaceResolver
Adds a namespace to this resolver.
adoptChild(Element, Element) - Static method in class net.sf.practicalxml.DomUtil
Adopts a child from another DOM, appending it to the passed element.
appendChild(Element, String) - Static method in class net.sf.practicalxml.DomUtil
Appends a child element with the specified name and no namespace, to a passed parent element.
appendChild(Element, String, String) - Static method in class net.sf.practicalxml.DomUtil
Appends a child element with the specified name and namespace, to a passed parent element.
appendChildInheritNamespace(Element, String) - Static method in class net.sf.practicalxml.DomUtil
Appends a child element with the specified name to a passed parent element.
appendContainer(String, Class<?>) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.Appender
Appends a container element to the current element.
appendContainer(String, Class<?>) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.BasicAppender
 
appendContainer(String, Class<?>) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.DirectAppender
 
appendContainer(String, Class<?>) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.MapAppender
 
appendText(Element, String) - Static method in class net.sf.practicalxml.DomUtil
Appends the specified text as a new text node on the specified element.
appendToAttributes(AttributesImpl) - Method in class net.sf.practicalxml.builder.AttributeNode
Helper method to produce a SAX Attributes object.
appendToElement(Element) - Method in class net.sf.practicalxml.builder.AttributeNode
 
appendToElement(Element) - Method in class net.sf.practicalxml.builder.CommentNode
 
appendToElement(Element) - Method in class net.sf.practicalxml.builder.ElementNode
 
appendToElement(Element) - Method in class net.sf.practicalxml.builder.Node
This method is called internally by ElementNode, to append its children to the DOM subtree rooted at the specified element.
appendToElement(Element) - Method in class net.sf.practicalxml.builder.PINode
 
appendToElement(Element) - Method in class net.sf.practicalxml.builder.TextNode
 
appendValue(String, Class<?>, String) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.Appender
Appends a value element to the current element.
appendValue(String, Class<?>, String) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.BasicAppender
 
appendValue(String, Class<?>, String) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.DirectAppender
 
appendValue(String, Class<?>, String) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.IndexedAppender
 
appendValue(String, Class<?>, String) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.MapAppender
 
asList(NodeList, Class<T>) - Static method in class net.sf.practicalxml.DomUtil
Creates a parameterized list from a NodeList, making it usable within the Java coding idiom.
assertCount(int, Node, String) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath selects a specified number of nodes.
assertCount(String, int, Node, String) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath selects a specified number of nodes.
assertCount(int, Node, XPathWrapper) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath selects a specified number of nodes.
assertCount(String, int, Node, XPathWrapper) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath selects a specified number of nodes.
assertEquals(String, Node, String) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath selects a particular String value.
assertEquals(String, String, Node, String) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath selects a particular String value.
assertEquals(String, Node, XPathWrapper) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath selects a particular String value.
assertEquals(String, String, Node, XPathWrapper) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath selects a particular String value.
assertExists(Node, String) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath selects at least one node.
assertExists(String, Node, String) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath selects at least one node, using the specified message if the assertion fails.
assertExists(Node, XPathWrapper) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath selects at least one node.
assertExists(String, Node, XPathWrapper) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath selects at least one node.
assertName(String, Element) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that an element has the given localname.
assertName(String, String, Element) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that an element has the given localname.
assertNamespaceAndName(String, String, Element) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that an element has the given local name and namespace URI.
assertNamespaceAndName(String, String, String, Element) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that an element has the given local name and namespace URI.
assertNotExists(Node, String) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath does not select any nodes.
assertNotExists(String, Node, String) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath does not select any nodes, using the specified message if the assertion fails.
assertNotExists(Node, XPathWrapper) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath does not select any nodes.
assertNotExists(String, Node, XPathWrapper) - Static method in class net.sf.practicalxml.junit.DomAsserts
Asserts that the specified XPath does not select any nodes.
AT_ARRAY_INDEX - Static variable in class net.sf.practicalxml.converter.ConversionConstants
Attribute used to hold the element index number for collections and arrays.
AT_DUMMY - Static variable in class net.sf.practicalxml.converter.ConversionConstants
A dummy attribute used to declare the conversion namespace at the root.
AT_ENUM_NAME - Static variable in class net.sf.practicalxml.converter.ConversionConstants
Attribute used to hold the name for enum instances.
AT_MAP_KEY - Static variable in class net.sf.practicalxml.converter.ConversionConstants
Attribute used to hold the item key value for maps.
AT_TYPE - Static variable in class net.sf.practicalxml.converter.ConversionConstants
Attribute used to hold the type of an element.
attribute(String, String, String) - Static method in class net.sf.practicalxml.builder.XmlBuilder
Creates a namespaced attribute.
attribute(String, String) - Static method in class net.sf.practicalxml.builder.XmlBuilder
Creates an attribute without namespace.
AttributeNode - Class in net.sf.practicalxml.builder
Holds an attribute, which may or may not be namespaced.
AttributeNode(String, String, String) - Constructor for class net.sf.practicalxml.builder.AttributeNode
 

B

Bean2XmlAppenders - Class in net.sf.practicalxml.converter.bean
Packaging class used for XML output appenders.
Bean2XmlAppenders() - Constructor for class net.sf.practicalxml.converter.bean.Bean2XmlAppenders
 
Bean2XmlAppenders.Appender - Class in net.sf.practicalxml.converter.bean
An Appender appends children to a single node of the output tree.
Bean2XmlAppenders.Appender(EnumSet<Bean2XmlOptions>, Object) - Constructor for class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.Appender
Constructor called by (@link DirectAppender).
Bean2XmlAppenders.Appender(Bean2XmlAppenders.Appender, Object) - Constructor for class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.Appender
Constructor called by all other subclasses.
Bean2XmlAppenders.BasicAppender - Class in net.sf.practicalxml.converter.bean
Basic appender, which appends new elements to a parent element.
Bean2XmlAppenders.BasicAppender(Bean2XmlAppenders.Appender, Element, Object) - Constructor for class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.BasicAppender
 
Bean2XmlAppenders.DirectAppender - Class in net.sf.practicalxml.converter.bean
An appender that sets values directly on the passed element.
Bean2XmlAppenders.DirectAppender(EnumSet<Bean2XmlOptions>, Element, Object) - Constructor for class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.DirectAppender
 
Bean2XmlAppenders.IndexedAppender - Class in net.sf.practicalxml.converter.bean
Appender for children of an indexed/iterated item (array, list, or set).
Bean2XmlAppenders.IndexedAppender(Bean2XmlAppenders.Appender, Element, Object) - Constructor for class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.IndexedAppender
 
Bean2XmlAppenders.MapAppender - Class in net.sf.practicalxml.converter.bean
Appender for children of a Map.
Bean2XmlAppenders.MapAppender(Bean2XmlAppenders.Appender, Element, Object) - Constructor for class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.MapAppender
 
Bean2XmlConverter - Class in net.sf.practicalxml.converter.bean
Driver class for converting a Java bean into an XML DOM.
Bean2XmlConverter(Bean2XmlOptions...) - Constructor for class net.sf.practicalxml.converter.bean.Bean2XmlConverter
 
Bean2XmlOptions - Enum in net.sf.practicalxml.converter.bean
Options used by Bean2XmlConverter to control the structure of the generated DOM tree.
BeanConverter - Class in net.sf.practicalxml.converter
Converts objects that follow the bean specification to or from an XML representation.
BeanConverter() - Constructor for class net.sf.practicalxml.converter.BeanConverter
 
bindDefaultNamespace(String) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Deprecated.
In practice, this method isn't particularly useful: if you're going to specify ":" on a term, you might as well specify a single-character prefix. It won't be removed, but a future implementation might parse an expression sans colons, and insert references.
bindFunction(FunctionResolver.SelfDescribingFunction) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Binds a self-describing function to this expression.
bindFunction(FunctionResolver.SelfDescribingFunction, String) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Binds a self-describing function to this expression, along with the prefix used to access that function.
bindFunction(QName, XPathFunction) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Binds a standard XPathFunction to this expression, handling any number of arguments.
bindFunction(QName, XPathFunction, int) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Binds a standard XPathFunction to this expression, handling a specific number of arguments.
bindFunction(QName, XPathFunction, int, int) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Binds a standard XPathFunction to this expression, handling a specific range of arguments.
bindFunction(FunctionResolver.SelfDescribingFunction) - Method in class net.sf.practicalxml.xpath.XPathWrapperFactory
Binds a self-describing function to this expression.
bindFunction(FunctionResolver.SelfDescribingFunction, String) - Method in class net.sf.practicalxml.xpath.XPathWrapperFactory
Binds a self-describing function to this expression, along with the prefix used to access that function.
bindFunction(QName, XPathFunction) - Method in class net.sf.practicalxml.xpath.XPathWrapperFactory
Binds a standard XPathFunction to this expression, handling any number of arguments.
bindFunction(QName, XPathFunction, int) - Method in class net.sf.practicalxml.xpath.XPathWrapperFactory
Binds a standard XPathFunction to this expression, handling a specific number of arguments.
bindFunction(QName, XPathFunction, int, int) - Method in class net.sf.practicalxml.xpath.XPathWrapperFactory
Binds a standard XPathFunction to this expression, handling a specific range of arguments.
bindNamespace(String, String) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Adds a namespace binding to this expression.
bindNamespace(String, String) - Method in class net.sf.practicalxml.xpath.XPathWrapperFactory
Adds a namespace binding, which will be used for subsequent wrappers created from this factory.
bindVariable(String, Object) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Binds a value to a variable, replacing any previous value for that variable.
bindVariable(QName, Object) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Binds a value to a variable, replacing any previous value for that variable.
bindVariable(String, Object) - Method in class net.sf.practicalxml.xpath.XPathWrapperFactory
Binds a value to a variable, replacing any previous value for that variable.
bindVariable(QName, Object) - Method in class net.sf.practicalxml.xpath.XPathWrapperFactory
Binds a value to a variable, replacing any previous value for that variable.

C

characters(char[], int, int) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
class2type(Class<?>) - Static method in class net.sf.practicalxml.converter.internal.TypeUtils
Returns the {practicalxml}:type value for the passed Java class.
clone() - Method in class net.sf.practicalxml.xpath.FunctionResolver
Returns a shallow clone of this object, containing all existing functions in a new lookup table.
clone() - Method in class net.sf.practicalxml.xpath.NamespaceResolver
Returns a deep clone of this object, that can then be independently manipulated.
clone() - Method in class net.sf.practicalxml.xpath.XPathWrapper
Creates a shallow clone of this object, omitting the compiled XPath expression.
CollectionConverter - Class in net.sf.practicalxml.converter
Converts between an XML DOM and hierarchical Java collections, according to the following rules:
CollectionConverter() - Constructor for class net.sf.practicalxml.converter.CollectionConverter
 
combineSchemas(InputSource...) - Static method in class net.sf.practicalxml.SchemaUtil
Parses and combines one or more input sources to produce an array of DOM documents containing schema components.
comment(String) - Static method in class net.sf.practicalxml.builder.XmlBuilder
Creates a comment node.
CommentNode - Class in net.sf.practicalxml.builder
Holds a comment.
CommentNode(String) - Constructor for class net.sf.practicalxml.builder.CommentNode
 
COMMON_NS_URI - Static variable in class net.sf.practicalxml.xpath.function.Constants
All functions in this package use this as their namespace URI.
compact(Source, Result) - Static method in class net.sf.practicalxml.OutputUtil
Serializes to a compact format, without prologue or whitespace between elements, using UTF-8 encoding.
compactStream(Document, OutputStream) - Static method in class net.sf.practicalxml.OutputUtil
Writes a DOM document to a stream using UTF-8 encoding, in a compact format without a prologue or whitespace between elements.
compactStream(XMLReader, OutputStream) - Static method in class net.sf.practicalxml.OutputUtil
Writes XML to a stream using UTF-8 encoding, in a compact format without prologue or whitespace between elements, using the passed XMLReader to generate a stream of SAX events.
compactStream(Document, OutputStream, String) - Static method in class net.sf.practicalxml.OutputUtil
Writes a DOM document to a stream using the specified encoding, without whitespace between elements, but with a prologue that specifes the encoding.
compactStream(XMLReader, OutputStream, String) - Static method in class net.sf.practicalxml.OutputUtil
Writes XML to a stream using the specified encoding, without prologue or whitespace between elements, using the passed XMLReader to generate a stream of SAX events.
compactString(Document) - Static method in class net.sf.practicalxml.OutputUtil
Writes a DOM document to a simple string format, without a prologue or whitespace between elements.
compactString(XMLReader) - Static method in class net.sf.practicalxml.OutputUtil
Writes XML in a simple string format, without prologue or whitespace between elements, using the passed XMLReader to generate a stream of SAX events.
compareTo(FunctionResolver.SelfDescribingFunction) - Method in class net.sf.practicalxml.xpath.FunctionResolver.AbstractSelfDescribingFunction
 
Constants - Class in net.sf.practicalxml.xpath.function
Constants for use in this package.
Constants() - Constructor for class net.sf.practicalxml.xpath.function.Constants
 
ConversionConstants - Class in net.sf.practicalxml.converter
Contains constants for various string values used by the conversion routines.
ConversionConstants() - Constructor for class net.sf.practicalxml.converter.ConversionConstants
 
ConversionException - Exception in net.sf.practicalxml.converter
A runtime exception thrown for any conversion error.
ConversionException(String) - Constructor for exception net.sf.practicalxml.converter.ConversionException
This constructor is called from code that is not location-aware.
ConversionException(String, Throwable) - Constructor for exception net.sf.practicalxml.converter.ConversionException
This constructor is called from code that is not location-aware.
ConversionException(String, Element) - Constructor for exception net.sf.practicalxml.converter.ConversionException
This constructor is invoked from XML->Bean conversions, where the converter is aware of its location.
ConversionException(String, Element, Throwable) - Constructor for exception net.sf.practicalxml.converter.ConversionException
This constructor is invoked from XML->Bean conversions, where the converter is aware of its location.
ConversionException(String, String) - Constructor for exception net.sf.practicalxml.converter.ConversionException
This constructor is invoked from Bean->XML conversions, where the converter is aware of its location.
ConversionException(String, String, Throwable) - Constructor for exception net.sf.practicalxml.converter.ConversionException
This constructor is invoked from Bean->XML conversions, where the converter is aware of its location.
ConversionException(ConversionException, String) - Constructor for exception net.sf.practicalxml.converter.ConversionException
This constructor is invoked from Bean->XML conversions, to prepend a field component to the location before rethrowing the exception.
ConversionUtils - Class in net.sf.practicalxml.converter.internal
Contains static utility methods and constants used by the conversion routines.
ConversionUtils() - Constructor for class net.sf.practicalxml.converter.internal.ConversionUtils
 
convert(Object, String) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlConverter
Creates an XML DOM with the specified root element name, and fills it by introspecting the passed object.
convert(Object, String, String) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlConverter
Creates an XML DOM with the specified root element name and namespace URI, and fills it by introspecting the passed object.
convert(Element, Class<T>) - Method in class net.sf.practicalxml.converter.bean.Xml2BeanConverter
Attempts to convert the passed DOM subtree into an object of the specified class.
convert() - Method in class net.sf.practicalxml.converter.json.Json2XmlConverter
Creates a new XML Document from the JSON source string.
convert(String) - Method in class net.sf.practicalxml.converter.json.Json2XmlConverter
Creates a new XML Document from the JSON source string.
convert(String, String) - Method in class net.sf.practicalxml.converter.json.Json2XmlConverter
Creates a new XML Document from the JSON source string.
convert(Element) - Method in class net.sf.practicalxml.converter.json.Json2XmlConverter
Parses the JSON source string and appends its contents to the passed element.
convert(Element) - Method in class net.sf.practicalxml.converter.json.Xml2JsonConverter
Converts the subtree rooted at elem to a JSON string.
convert(Element, StringBuilder) - Method in class net.sf.practicalxml.converter.json.Xml2JsonConverter
Converts the subtree rooted at elem to a JSON string, appending to an existing buffer.
convertToJava(Document, Class<T>, Xml2BeanOptions...) - Static method in class net.sf.practicalxml.converter.BeanConverter
Creates a new Java object from the root of the passed Document .
convertToJava(Element, Class<T>, Xml2BeanOptions...) - Static method in class net.sf.practicalxml.converter.BeanConverter
Creates a new Java object from the the passed Element.
convertToJson(Document, Xml2JsonOptions...) - Static method in class net.sf.practicalxml.converter.JsonConverter
Creates a new JSON string from the root of the passed Document .
convertToJson(Element, Xml2JsonOptions...) - Static method in class net.sf.practicalxml.converter.JsonConverter
Creates a new JSON string from the the passed Element.
convertToJson(Element, StringBuilder, Xml2JsonOptions...) - Static method in class net.sf.practicalxml.converter.JsonConverter
Creates a new JSON string from the the passed Element, and appends that string to the passed buffer (the buffer is actually passed into the JSON construction code).
convertToMap(Element, String...) - Static method in class net.sf.practicalxml.converter.CollectionConverter
Converts a single XML element into a map.
convertToMap(List<Element>, String...) - Static method in class net.sf.practicalxml.converter.CollectionConverter
Converts a list of XML elements into a list of maps.
convertToMap(Element, Set<String>) - Static method in class net.sf.practicalxml.converter.CollectionConverter
Common conversion code for a single element, with digested filter.
convertToString(Object) - Static method in class net.sf.practicalxml.xpath.AbstractStringFunction
Converts the passed object to a string, applying the same rules used for the built-in string() function.
convertToXml(Object, String, String, Bean2XmlOptions...) - Static method in class net.sf.practicalxml.converter.BeanConverter
Creates a new DOM document from the passed bean, in which all elements are members of the specified namespace and will inherit the root's prefix (if any).
convertToXml(Object, String, Bean2XmlOptions...) - Static method in class net.sf.practicalxml.converter.BeanConverter
Creates a new DOM document from the passed bean, without namespace.
convertToXml(Map<String, ?>, String, String...) - Static method in class net.sf.practicalxml.converter.CollectionConverter
Creates a new DOM document from the passed map, without any namespace.
convertToXml(Map<String, ?>, QName, String...) - Static method in class net.sf.practicalxml.converter.CollectionConverter
Creates a new DOM document from the passed map, in which all elements are members of the specified namespace and will inherit the root's prefix (if any).
convertToXml(String, String, String, Json2XmlOptions...) - Static method in class net.sf.practicalxml.converter.JsonConverter
Creates a new DOM document from the passed JSON string, in which all elements are members of the specified namespace and will inherit the root's prefix (if any).
convertToXml(String, String, Json2XmlOptions...) - Static method in class net.sf.practicalxml.converter.JsonConverter
Creates a new DOM document from the passed bean, without namespace.
convertToXml(String, Element, Json2XmlOptions...) - Static method in class net.sf.practicalxml.converter.JsonConverter
Converts the passed JSON string to XML, appended as children of the passed element.
convertWithoutCast(Element, Class<?>) - Method in class net.sf.practicalxml.converter.bean.Xml2BeanConverter
Attempts to convert the passed DOM subtree into an object of the specified class.

D

DomAsserts - Class in net.sf.practicalxml.junit
JUnit assertions for DOM documents.
DomAsserts() - Constructor for class net.sf.practicalxml.junit.DomAsserts
 
DomUtil - Class in net.sf.practicalxml
A collection of static utility methods for working with DOM trees.
DomUtil() - Constructor for class net.sf.practicalxml.DomUtil
 

E

EL_CALENDAR_DATE - Static variable in class net.sf.practicalxml.converter.ConversionConstants
Element name used to hold date from Calendar conversion.
EL_CALENDAR_FIRST_DAY - Static variable in class net.sf.practicalxml.converter.ConversionConstants
Element name used to hold first day of week from Calendar conversion.
EL_CALENDAR_MILLIS - Static variable in class net.sf.practicalxml.converter.ConversionConstants
Element name used to hold milliseconds from Calendar conversion.
EL_CALENDAR_MIN_DAYS - Static variable in class net.sf.practicalxml.converter.ConversionConstants
Element name used to hold minimum days in first week from Calendar conversion.
EL_CALENDAR_TIMEZONE - Static variable in class net.sf.practicalxml.converter.ConversionConstants
Element name used to hold timezone from Calendar conversion.
EL_COLLECTION_ITEM - Static variable in class net.sf.practicalxml.converter.ConversionConstants
Element name used to hold unnamed items from collections and arrays.
EL_DEFAULT_ROOT - Static variable in class net.sf.practicalxml.converter.ConversionConstants
Name of root element, where not specified by caller.
element(String, String, Node...) - Static method in class net.sf.practicalxml.builder.XmlBuilder
Creates an element, with optional namespace.
element(String, Node...) - Static method in class net.sf.practicalxml.builder.XmlBuilder
Creates an element that does not have a namespace.
ElementNode - Class in net.sf.practicalxml.builder
The primary class for building XML trees and converting them to different JAXP-centric forms.
elementToString(Element) - Static method in class net.sf.practicalxml.OutputUtil
A simple toString() for an element, using the format "{NSURI}LOCALNAME"; if the element has no namespace, the brackets remain but are empty.
endDocument() - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
endElement(String, String, String) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
endPrefixMapping(String) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
equals(Object) - Method in class net.sf.practicalxml.xpath.FunctionResolver.AbstractSelfDescribingFunction
 
equals(Object) - Method in class net.sf.practicalxml.xpath.FunctionResolver
Two instances are equal if they have the same number of functions, and each has a counterpart with the same QName and arity range (but not the same implementation).
equals(Object) - Method in class net.sf.practicalxml.xpath.NamespaceResolver
Two instances are considered equal if they have the same mappings, including default namespace.
equals(Object) - Method in class net.sf.practicalxml.xpath.SimpleNamespaceResolver
Two instances are considered equal if they have the same mappings, including default namespace.
equals(Object) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Two instances are considered equal if they have the same expression, namespace mappings, variable mappings, and function mappings.
error(SAXParseException) - Method in class net.sf.practicalxml.util.ErrorHandlerAdapter
 
error(SAXParseException) - Method in class net.sf.practicalxml.util.ExceptionErrorHandler
 
error(SAXParseException) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
ErrorHandlerAdapter - Class in net.sf.practicalxml.util
An implementation of ErrorHandler that does nothing; meant to be used as the base for a useful implementation, in cases where you only want to intercept certain conditions (such as validation errors).
ErrorHandlerAdapter() - Constructor for class net.sf.practicalxml.util.ErrorHandlerAdapter
 
escape(String) - Static method in class net.sf.practicalxml.converter.internal.JsonUtils
Escapes a string, replacing quotes, backslashes, non-printable and non-ASCII characters by a defined set of single-character or 4-digit unicode escapes.
escape(String) - Static method in class net.sf.practicalxml.XmlUtil
Escapes the passed string, converting the five reserved XML characters into their entities: &amp;, &lt;, &gt;, &apos;, and &quot;.
evaluate(List) - Method in class net.sf.practicalxml.xpath.AbstractFunction
Invokes methods defined by the subclasses to evaluate the function.
evaluate(List) - Method in class net.sf.practicalxml.xpath.AbstractStringFunction
 
evaluate(String, List<?>) - Method in class net.sf.practicalxml.xpath.AbstractStringFunction
Subclasses must implement this method.
evaluate(String, List<?>) - Method in class net.sf.practicalxml.xpath.function.Lowercase
 
evaluate(String, List<?>) - Method in class net.sf.practicalxml.xpath.function.Uppercase
 
evaluate(String, List<?>) - Method in class net.sf.practicalxml.xpath.function.XsiBoolean
 
evaluate(Node) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Applies this expression to the the specified node, converting the resulting NodeList into a java.util.List.
evaluate(Node, Class<T>) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Applies this expression to the the specified node, converting the resulting NodeList into a java.util.List containing only nodes of the specified type.
evaluateAsBoolean(Node) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Applies this expression to the the specified node, requesting the BOOLEAN return type.
evaluateAsElement(Node) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Applies this expression to the the specified node, and returning the first Element from the resulting nodelist.
evaluateAsNumber(Node) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Applies this expression to the specified node, requesting the NUMBER return type.
evaluateAsString(Node) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Applies this expression to the specified node, requesting the STRING return type.
evaluateAsStringList(Node) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Applies this expression to the specified node, requesting the NODESET return type, and then retrieving the text content for each returned node.
ExceptionErrorHandler - Class in net.sf.practicalxml.util
An error handler that throws XmlException on any error, and maintains a list of warnings.
ExceptionErrorHandler() - Constructor for class net.sf.practicalxml.util.ExceptionErrorHandler
 

F

fatalError(SAXParseException) - Method in class net.sf.practicalxml.util.ErrorHandlerAdapter
 
fatalError(SAXParseException) - Method in class net.sf.practicalxml.util.ExceptionErrorHandler
 
fatalError(SAXParseException) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
filter(NodeList, Class<T>) - Static method in class net.sf.practicalxml.DomUtil
Extracts all nodes of a given type from the passed NodeList, creating a Java list of the nodes in document order.
formatXsdBoolean(boolean) - Static method in class net.sf.practicalxml.XmlUtil
Converts a boolean value to the literal strings "true" or "false" (XML Schema boolean fields also allow "1" or "0").
formatXsdDatetime(Date) - Static method in class net.sf.practicalxml.XmlUtil
Converts a Java Date object to a string, using the format specified by XML Schema for dateTime elements.
formatXsdDecimal(double) - Static method in class net.sf.practicalxml.XmlUtil
Converts a Java double to a string, using the format specified by XML Schema for decimal elements.
formatXsdDecimal(Number) - Static method in class net.sf.practicalxml.XmlUtil
Converts a Java double to a string, using the format specified by XML Schema for decimal elements.
FunctionResolver - Class in net.sf.practicalxml.xpath
An XPathFunctionResolver that is intended to be easily configured (using the Builder pattern), can support multiple functions with the same name but different arity, and provides a simplified interface for functions that know their own name (ie, subclasses of AbstractFunction.
FunctionResolver() - Constructor for class net.sf.practicalxml.xpath.FunctionResolver
 
FunctionResolver.AbstractSelfDescribingFunction - Class in net.sf.practicalxml.xpath
A base implementation of a self-describing function.
FunctionResolver.AbstractSelfDescribingFunction(QName, int, int) - Constructor for class net.sf.practicalxml.xpath.FunctionResolver.AbstractSelfDescribingFunction
 
FunctionResolver.SelfDescribingFunction - Interface in net.sf.practicalxml.xpath
A self-describing function: one that can describe its own name and arity, and compare itself to other self-describing functions.

G

getAbsolutePath(Element) - Static method in class net.sf.practicalxml.DomUtil
Returns the path from the root of the document to the specified element, as an XPath expression using positional predicates to differentiate between nodes with the same local name, ignoring namespace.
getAbsolutePath(Element, NamespaceContext) - Static method in class net.sf.practicalxml.DomUtil
Returns the path from the root of the document to the specified element, as an XPath expression using positional predicates to differentiate between nodes with the same name and namespace.
getAbsolutePath(Element, NamespaceResolver) - Static method in class net.sf.practicalxml.DomUtil
Returns the path from the root of the document to the specified element, as an XPath expression using positional predicates to differentiate between nodes with the same name and namespace.
getAllPrefixes() - Method in class net.sf.practicalxml.xpath.NamespaceResolver
Returns a list of all prefixes known to this resolver, in alphabetical order.
getAttribute(Element, String) - Static method in class net.sf.practicalxml.converter.internal.ConversionUtils
Retrieves an arbitrary attribute.
getAttributes(Element) - Static method in class net.sf.practicalxml.DomUtil
Returns all attributes for the passed element, in a mutable list.
getChild(Node, String) - Static method in class net.sf.practicalxml.DomUtil
Returns the first child element with the given localname, null if there are no such nodes.
getChild(Node, String, String) - Static method in class net.sf.practicalxml.DomUtil
Returns the first child element with the given namespace and local name, null if there are no such elements.
getChildren(Node) - Static method in class net.sf.practicalxml.DomUtil
Returns all Element children of the passed node, in document order.
getChildren(Node, String) - Static method in class net.sf.practicalxml.DomUtil
Returns the children of the passed element that have the given localname, ignoring namespace.
getChildren(Node, String, String) - Static method in class net.sf.practicalxml.DomUtil
Returns the children of the passed element that have the given namespace and localname (ignoring prefix).
getDefaultNamespace() - Method in class net.sf.practicalxml.xpath.NamespaceResolver
Returns the default namespace, an empty string if one has not yet been set.
getDeferredExceptions() - Method in class net.sf.practicalxml.converter.bean.Bean2XmlConverter
If the deferred exceptions option has been set, returns the list of deferred exceptions.
getDeferredExceptions() - Method in class net.sf.practicalxml.converter.bean.Xml2BeanConverter
If the deferred exceptions option has been set, returns the list of deferred exceptions.
getField() - Method in exception net.sf.practicalxml.converter.ConversionException
Returns the name of the field where this exception occurred, null if unknown.
getLocalName(String) - Static method in class net.sf.practicalxml.builder.Node
Utility method to return a local name from either a qualified or non-qualified name.
getLocalName(Element) - Static method in class net.sf.practicalxml.DomUtil
Returns the local name of an element.
getLocalName(Attr) - Static method in class net.sf.practicalxml.DomUtil
Returns the local name of an attribute.
getMaxArgCount() - Method in class net.sf.practicalxml.xpath.FunctionResolver.AbstractSelfDescribingFunction
 
getMaxArgCount() - Method in interface net.sf.practicalxml.xpath.FunctionResolver.SelfDescribingFunction
Returns the maximum number of arguments handled by this function.
getMinArgCount() - Method in class net.sf.practicalxml.xpath.FunctionResolver.AbstractSelfDescribingFunction
 
getMinArgCount() - Method in interface net.sf.practicalxml.xpath.FunctionResolver.SelfDescribingFunction
Returns the minimum number of arguments handled by this function.
getName() - Method in class net.sf.practicalxml.xpath.FunctionResolver.AbstractSelfDescribingFunction
 
getName() - Method in interface net.sf.practicalxml.xpath.FunctionResolver.SelfDescribingFunction
Returns the name of this function.
getNamespaceUri() - Method in class net.sf.practicalxml.xpath.FunctionResolver.AbstractSelfDescribingFunction
 
getNamespaceUri() - Method in interface net.sf.practicalxml.xpath.FunctionResolver.SelfDescribingFunction
Returns the namespace URI for this function.
getNamespaceURI(String) - Method in class net.sf.practicalxml.xpath.NamespaceResolver
Returns the namespace URI bound to a given prefix, null if no URI is bound to the specified prefix.
getNamespaceURI(String) - Method in class net.sf.practicalxml.xpath.SimpleNamespaceResolver
Returns the namespace URI bound to the passed prefix, null if the prefix does not correspond to the binding defined by this instance.
getPath(Element, String...) - Static method in class net.sf.practicalxml.DomUtil
Returns the path from the root of the document to the specified element, consisting of each node's qualified name, separated by slashes.
getPrefix(String) - Method in class net.sf.practicalxml.xpath.NamespaceResolver
Returns the first prefix in alphabetical order bound to this namespace URI, null if there is no binding for the namespace.
getPrefix(String) - Method in class net.sf.practicalxml.xpath.SimpleNamespaceResolver
Returns the prefix bound to the passed namespace URI, null if the URI does not correspond to the binding defined by this instance.
getPrefixes(String) - Method in class net.sf.practicalxml.xpath.NamespaceResolver
Returns an iterator over all prefixes bound to this namespace URI, in alphabetical order, an empty iterator if there are no bindings.
getPrefixes(String) - Method in class net.sf.practicalxml.xpath.SimpleNamespaceResolver
Returns an iterator over prefixes for the passed URI, an empty iterator if the URI does not correspond to the binding defined by this instance.
getQName() - Method in class net.sf.practicalxml.xpath.FunctionResolver.AbstractSelfDescribingFunction
 
getQName() - Method in interface net.sf.practicalxml.xpath.FunctionResolver.SelfDescribingFunction
Returns the qualified name of this function, consisting of name and namespace (but not prefix).
getResult(T) - Method in class net.sf.practicalxml.xpath.AbstractFunction
Returns the result of this invocation.
getSiblings(Element) - Static method in class net.sf.practicalxml.DomUtil
Returns all Element children of the passed element's parent (ie, the element and its siblings).
getSiblings(Element, String) - Static method in class net.sf.practicalxml.DomUtil
Returns all Element children of the passed element's parent that have the specified localname, ignoring namespace.
getSiblings(Element, String, String) - Static method in class net.sf.practicalxml.DomUtil
Returns all Element children of the passed element's parent that have the specified namespace and local name.
getText(Element) - Static method in class net.sf.practicalxml.DomUtil
Returns the concatenation of all text and CDATA nodes that are immediate children of the passed node.
getType(Element, boolean) - Static method in class net.sf.practicalxml.converter.internal.TypeUtils
Returns the Java class corresponding to the passed element's {practicalxml}:type attribute.
getTypeValue(Element) - Static method in class net.sf.practicalxml.converter.internal.TypeUtils
Returns the value of the passed element's {practicalxml}:type attribute, null if the attribute is not set or contains an empty string.
getWarnings() - Method in class net.sf.practicalxml.util.ExceptionErrorHandler
Returns the list of warnings generated during parsing.
getXPath() - Method in exception net.sf.practicalxml.converter.ConversionException
Returns the XPath of the node causing this exception, null if unknown.
getXsiNil(Element) - Static method in class net.sf.practicalxml.converter.internal.ConversionUtils
Returns the value of the xsi:nil attribute on the passed element, false if the attribute is not set.
getXsiNil(Element) - Static method in class net.sf.practicalxml.XsiUtil
Returns the value of the xsi:nil attribute on the passed element, false if the attribute is not set.

H

hasChildren(Element) - Static method in class net.sf.practicalxml.DomUtil
Determines whether the passed element has any child nodes, of any type.
hasElementChildren(Element) - Static method in class net.sf.practicalxml.DomUtil
Determines whether the passed element has any element children.
hashCode() - Method in class net.sf.practicalxml.xpath.FunctionResolver.AbstractSelfDescribingFunction
 
hashCode() - Method in class net.sf.practicalxml.xpath.FunctionResolver
 
hashCode() - Method in class net.sf.practicalxml.xpath.NamespaceResolver
 
hashCode() - Method in class net.sf.practicalxml.xpath.SimpleNamespaceResolver
 
hashCode() - Method in class net.sf.practicalxml.xpath.XPathWrapper
Hash code is driven by the expression, ignoring differences between namespaces, variables, and functions.
hasNext() - Method in class net.sf.practicalxml.util.NodeListIterator
 
hasTextChildren(Element) - Static method in class net.sf.practicalxml.DomUtil
Determines whether the passed element has any text/cdata children.

I

ignorableWhitespace(char[], int, int) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
indented(Source, Result, int) - Static method in class net.sf.practicalxml.OutputUtil
Serializes to a human-readable format, with each element starting on a new line, and child elements indented a specified amount from their parent.
indentedString(Document, int) - Static method in class net.sf.practicalxml.OutputUtil
Writes a DOM document to a string format, with indenting between elements but without a prologue.
indentedString(XMLReader, int) - Static method in class net.sf.practicalxml.OutputUtil
Writes XML in a simple string format, without prologue or whitespace between elements, using the passed XMLReader to generate a stream of SAX events.
init() - Method in class net.sf.practicalxml.xpath.AbstractFunction
Creates a helper object to preserve intermediate results.
Introspection - Class in net.sf.practicalxml.converter.bean
Deprecated.
This class is now contained in the KDGCommons library; all future enhancements or bugfixes will be made to that version. This version is a thin wrapper over that version, allowing the local variant of IntrospectionCache (also deprecated) to maintin its segmature. Both will be removed in release 1.2.
Introspection(Class<?>) - Constructor for class net.sf.practicalxml.converter.bean.Introspection
Deprecated.
 
IntrospectionCache - Class in net.sf.practicalxml.converter.bean
Deprecated.
This class is now contained in the KDGCommons library; all future enhancements or bugfixes will be made to that version. This version will be removed in release 1.2.
IntrospectionCache() - Constructor for class net.sf.practicalxml.converter.bean.IntrospectionCache
Deprecated.
Creates an instance that uses a local cache.
IntrospectionCache(boolean) - Constructor for class net.sf.practicalxml.converter.bean.IntrospectionCache
Deprecated.
Creates an instance that will either use a local or shared (static) cache.
isArityMatch(int) - Method in class net.sf.practicalxml.xpath.FunctionResolver.AbstractSelfDescribingFunction
 
isArityMatch(int) - Method in interface net.sf.practicalxml.xpath.FunctionResolver.SelfDescribingFunction
Determines whether this function can handle the specified number of arguments.
isBlank(String) - Static method in class net.sf.practicalxml.internal.StringUtils
Deprecated.
Returns true if the passed string is null, zero-length, or contains only whitespace characters as defined by Character.isWhitespace(); false otherwise.
isCircularReference(Object) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.Appender
Determines whether the passed object is a circular reference.
isConvertableToString(Object) - Method in class net.sf.practicalxml.converter.internal.JavaStringConversions
Determines whether the passed object has a simple string representation.
isConvertableToString(Class<?>) - Method in class net.sf.practicalxml.converter.internal.JavaStringConversions
Determines whether the objects of the specified class have a simple string representation.
isEmpty(String) - Static method in class net.sf.practicalxml.internal.StringUtils
Deprecated.
Returns true if the passed string is null or zero-length; false otherwise (including a string containing only whitespace).
isLegal(String) - Static method in class net.sf.practicalxml.XmlUtil
Determines whether the passed string contains any illegal characters, per section 2.2 of the XML spec.
isMatch(QName, int) - Method in class net.sf.practicalxml.xpath.FunctionResolver.AbstractSelfDescribingFunction
 
isMatch(QName, int) - Method in interface net.sf.practicalxml.xpath.FunctionResolver.SelfDescribingFunction
Determines whether this function is a match for a call to XPathFunctionResolver.resolveFunction().
isNamed(Element, String, String) - Static method in class net.sf.practicalxml.DomUtil
Determines whether the passed element has the expected namespace URI and local name.
isOptionSet(Bean2XmlOptions) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.Appender
Hides the mechanism that we used to manage options.
iterator() - Method in class net.sf.practicalxml.util.NodeListIterable
 

J

JAVA_TYPE_PREFIX - Static variable in class net.sf.practicalxml.converter.internal.TypeUtils
Prefix for xsi:type values for elements holding Java objects as serialized by BeanConverter.
JavaStringConversions - Class in net.sf.practicalxml.converter.internal
Handles conversion of objects that have a simple string representation.
JavaStringConversions(boolean) - Constructor for class net.sf.practicalxml.converter.internal.JavaStringConversions
 
Json2XmlConverter - Class in net.sf.practicalxml.converter.json
This class contains a hand-written recursive-descent parser for JSON strings.
Json2XmlConverter(String, Json2XmlOptions...) - Constructor for class net.sf.practicalxml.converter.json.Json2XmlConverter
 
Json2XmlOptions - Enum in net.sf.practicalxml.converter.json
Options to control conversion from JSON strings to XML documents.
JsonConverter - Class in net.sf.practicalxml.converter
Converts between XML DOMs and JSON (Javascript Object Notation) strings.
JsonConverter() - Constructor for class net.sf.practicalxml.converter.JsonConverter
 
JsonUtils - Class in net.sf.practicalxml.converter.internal
Static utility methods for working with JSON content.
JsonUtils() - Constructor for class net.sf.practicalxml.converter.internal.JsonUtils
 

L

lookup(Class<?>) - Method in class net.sf.practicalxml.converter.bean.IntrospectionCache
Deprecated.
Returns an Introspection of the passed class.
Lowercase - Class in net.sf.practicalxml.xpath.function
Converts the string value of its argument to lowercase, using a locale-aware conversion.
Lowercase() - Constructor for class net.sf.practicalxml.xpath.function.Lowercase
 

N

NamespaceResolver - Class in net.sf.practicalxml.xpath
Maintains a bi-directional lookup table for mappings between namespace URIs and prefixes.
NamespaceResolver() - Constructor for class net.sf.practicalxml.xpath.NamespaceResolver
 
net.sf.practicalxml - package net.sf.practicalxml
This top-level package contains the basic toolkit: a set of classes that expose static methods.
net.sf.practicalxml.builder - package net.sf.practicalxml.builder
XmlBuilder is a tool for declarative construction of XML.
net.sf.practicalxml.converter - package net.sf.practicalxml.converter
This package contains classes to convert between XML and a variety of other formats.
net.sf.practicalxml.converter.bean - package net.sf.practicalxml.converter.bean
This package contains classes to convert Java objects to and from XML.
net.sf.practicalxml.converter.internal - package net.sf.practicalxml.converter.internal
 
net.sf.practicalxml.converter.json - package net.sf.practicalxml.converter.json
This package contains classes to convert JSON (JavaScript Object Notation) strings (as defined json.org ) to and from an XML DOM.
net.sf.practicalxml.internal - package net.sf.practicalxml.internal
This package contains classes used internally by the PracticalXML library.
net.sf.practicalxml.junit - package net.sf.practicalxml.junit
 
net.sf.practicalxml.util - package net.sf.practicalxml.util
This package contains miscellaneous support classes.
net.sf.practicalxml.xpath - package net.sf.practicalxml.xpath
This package support classes that are primarily used for XPath evaluation.
net.sf.practicalxml.xpath.function - package net.sf.practicalxml.xpath.function
This package contains reusable XPath functions, implemented using AbstractFunction.
newDocument() - Static method in class net.sf.practicalxml.DomUtil
Creates a new empty Document.
newDocument(String, String) - Static method in class net.sf.practicalxml.DomUtil
Creates a new Document, along with a root Element with the specified name and namespace.
newDocument(String) - Static method in class net.sf.practicalxml.DomUtil
Creates a new Document, along with a root Element with the specified name and no namespace.
newDocument(QName) - Static method in class net.sf.practicalxml.DomUtil
Creates a new Document, along with a root Element with the specified qualified name.
newFactory(ErrorHandler) - Static method in class net.sf.practicalxml.SchemaUtil
Creates a new javax.xml.validation.SchemaFactory instance for validation with XML Schema, which reports errors via the specified error handler.
newSchema(InputSource...) - Static method in class net.sf.practicalxml.SchemaUtil
Parses one or more input sources to produce a Schema object.
newSchema(SchemaFactory, InputSource...) - Static method in class net.sf.practicalxml.SchemaUtil
Parses one or more input sources to produce a Schema object from the passed factory.
newSchema(SchemaFactory, Document...) - Static method in class net.sf.practicalxml.SchemaUtil
Compiles one or more DOM documents to produce a Schema object from the passed factory.
newTransformer() - Method in class net.sf.practicalxml.internal.TransformerFactoryHelper
Creates a new transformer instance that supports the requested output configuration.
newXPath(String) - Method in class net.sf.practicalxml.xpath.XPathWrapperFactory
Returns an XPathWrapper instance for the specified expression.
next() - Method in class net.sf.practicalxml.util.NodeListIterator
 
Node - Class in net.sf.practicalxml.builder
A lightweight counterpart of a DOM Node, focused on creation rather than manipulation.
Node() - Constructor for class net.sf.practicalxml.builder.Node
 
NodeListIterable - Class in net.sf.practicalxml.util
A wrapper for a DOM NodeList that allows it to be used in a JDK 1.5 for-each loop.
NodeListIterable(NodeList) - Constructor for class net.sf.practicalxml.util.NodeListIterable
 
NodeListIterator - Class in net.sf.practicalxml.util
A wrapper for NodeList that provides full iterator behavior.
NodeListIterator(NodeList) - Constructor for class net.sf.practicalxml.util.NodeListIterator
Creates an iterator that returns all nodes from the passed list.
NodeListIterator(NodeList, Class<?>) - Constructor for class net.sf.practicalxml.util.NodeListIterator
Creates an iterator that returns only the nodes of a specific class from the passed list.
notationDecl(String, String, String) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
NS_CONVERSION - Static variable in class net.sf.practicalxml.converter.ConversionConstants
Namespace for attributes defined by the converter.

O

OutputUtil - Class in net.sf.practicalxml
Contains static methods to generate XML output with a variety of format options.
OutputUtil() - Constructor for class net.sf.practicalxml.OutputUtil
 
overrideType(Element, String) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.Appender
Updates the type attribute to the specified value, if types are in use; otherwise does nothing.

P

parse(String, Class<?>) - Method in class net.sf.practicalxml.converter.internal.JavaStringConversions
Parses the passed string as a Java primitive object of the specified type.
parse(InputSource, ErrorHandler) - Static method in class net.sf.practicalxml.ParseUtil
Parses the supplied source with a namespace-aware, non-validating parser, using a caller-supplied error handler.
parse(InputSource) - Static method in class net.sf.practicalxml.ParseUtil
Parses the supplied source with a namespace-aware, non-validating parser, using the built-in error handler that throws on parse errors and ignores warnings.
parse(InputStream) - Static method in class net.sf.practicalxml.ParseUtil
Parses the supplied source with a namespace-aware, non-validating parser, using the built-in error handler that throws on parse errors and ignores warnings.
parse(String) - Static method in class net.sf.practicalxml.ParseUtil
Parses a string containing XML, using a namespace-aware, non-validating parser.
parse(File) - Static method in class net.sf.practicalxml.ParseUtil
Parses a file using a namespace-aware, non-validating parser.
parse(InputSource) - Method in class net.sf.practicalxml.util.SimpleXMLReader
 
parse(String) - Method in class net.sf.practicalxml.util.SimpleXMLReader
 
parseDigit(char, int) - Static method in class net.sf.practicalxml.internal.StringUtils
Deprecated.
Parses the passed character as a digit in the specified base, returning its value.
parseFromClasspath(String) - Static method in class net.sf.practicalxml.ParseUtil
Parses a resource loaded from the classpath, using the current thread's context classloader, and a default error handler.
parseFromClasspath(String, ErrorHandler) - Static method in class net.sf.practicalxml.ParseUtil
Parses a resource loaded from the classpath, using the current thread's context classloader, and a specified error handler.
parseFromClasspath(String, Class<?>) - Static method in class net.sf.practicalxml.ParseUtil
Parses a resource loaded from the classpath, using the classloader associated with the specified class, and a default error handler.
parseFromClasspath(String, Class<?>, ErrorHandler) - Static method in class net.sf.practicalxml.ParseUtil
Parses a resource loaded from the classpath, using the classloader associated with the specified class, and the specified error handler.
parseSources(InputSource[]) - Static method in class net.sf.practicalxml.SchemaUtil
Parses an array of org.xml.sax.InputSource objects, and performs some (minimal) level of validation on them.
ParseUtil - Class in net.sf.practicalxml
A collection of static methods for parsing XML into a DOM, with or without validation.
ParseUtil() - Constructor for class net.sf.practicalxml.ParseUtil
 
parseXsdBoolean(String) - Static method in class net.sf.practicalxml.XmlUtil
Parses an XML Schema boolean value, accepting any of the legal formats and trimming whitespace.
parseXsdDatetime(String) - Static method in class net.sf.practicalxml.XmlUtil
Parses an XML Schema dateTime value, accepting any of the legal formats.
parseXsdDecimal(String) - Static method in class net.sf.practicalxml.XmlUtil
Parses an XML Schema decimal value.
PINode - Class in net.sf.practicalxml.builder
Holds a processing instruction.
PINode(String, String) - Constructor for class net.sf.practicalxml.builder.PINode
 
processArg(int, String, T) - Method in class net.sf.practicalxml.xpath.AbstractFunction
Processes a String argument.
processArg(int, Number, T) - Method in class net.sf.practicalxml.xpath.AbstractFunction
Processes a Number argument.
processArg(int, Boolean, T) - Method in class net.sf.practicalxml.xpath.AbstractFunction
Processes a Boolean argument.
processArg(int, Node, T) - Method in class net.sf.practicalxml.xpath.AbstractFunction
Processes a Node argument.
processArg(int, NodeList, T) - Method in class net.sf.practicalxml.xpath.AbstractFunction
Processes a NodeList argument.
processingInstruction(String, String) - Static method in class net.sf.practicalxml.builder.XmlBuilder
Creates a processing instruction node.
processingInstruction(String, String) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
processNullArg(int, T) - Method in class net.sf.practicalxml.xpath.AbstractFunction
Processes a null argument — it's unclear whether this can ever happen.
processUnexpectedArg(int, Object, T) - Method in class net.sf.practicalxml.xpath.AbstractFunction
Processes an argument that is not one of the defined types for XPath evaluation — it is unclear whether this can actually happen.

R

remove() - Method in class net.sf.practicalxml.util.NodeListIterator
 
removeAllChildren(Node) - Static method in class net.sf.practicalxml.DomUtil
Removes all children from the passed node.
removeEmptyTextRecursive(Node) - Static method in class net.sf.practicalxml.DomUtil
Removes all descendent text nodes that contain only whitespace.
resolveEntity(String, String) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
resolveFunction(QName, int) - Method in class net.sf.practicalxml.xpath.FunctionResolver
Picks the "most eligble" function of those bound to this resolver.

S

SchemaUtil - Class in net.sf.practicalxml
A collection of static utility methods for working with XML Schema documents.
SchemaUtil() - Constructor for class net.sf.practicalxml.SchemaUtil
 
setAttribute(Element, String, String) - Static method in class net.sf.practicalxml.converter.internal.ConversionUtils
Sets an arbitrary attribute within the "conversion" namespace.
setDefaultNamespace(String) - Method in class net.sf.practicalxml.xpath.NamespaceResolver
Sets the default namespace -- the namespace that will be returned when an empty string is passed to the resolver.
setDocumentLocator(Locator) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
setFunctionResolver(FunctionResolver) - Method in class net.sf.practicalxml.xpath.XPathWrapper
Attaches a pre-build FunctionResolver to this wrapper, replacing the existing resolver (and removing all bound functions).
setIndent(int) - Method in class net.sf.practicalxml.internal.TransformerFactoryHelper
Enables indentation of the output, with the specified number of spaces at each level.
setPrologue() - Method in class net.sf.practicalxml.internal.TransformerFactoryHelper
Enables output of a prologue, without specifying an encoding (this means that the output must be encoded as UTF-8).
setPrologue(String) - Method in class net.sf.practicalxml.internal.TransformerFactoryHelper
Enables output of a prologue with specified encoding.
setText(Element, String) - Static method in class net.sf.practicalxml.DomUtil
Replaces all existing text nodes on the specified element with a single node containing the specified text.
setType(Element, Class<?>) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.Appender
Optionally sets a type attribute on the generated element.
setType(Element, Class<?>) - Static method in class net.sf.practicalxml.converter.internal.TypeUtils
Sets the {practicalxml}:type attribute to a value appropriate for the passed Java class.
setValue(Element, String) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.Appender
Sets the value of the generated element.
setXsiNil(Element, boolean) - Static method in class net.sf.practicalxml.converter.internal.ConversionUtils
Sets the xsi:nil attribute to the passed value.
setXsiNil(Element, boolean) - Static method in class net.sf.practicalxml.XsiUtil
Sets the xsi:nil attribute to the passed value.
shouldSkip(Object) - Method in class net.sf.practicalxml.converter.bean.Bean2XmlAppenders.Appender
Returns true to indicate whether the appender should not output the passed value.
SimpleNamespaceResolver - Class in net.sf.practicalxml.xpath
Implements a bidirectional lookup between a single namespace URI and its prefix, for use with XPath expressions.
SimpleNamespaceResolver(String, String) - Constructor for class net.sf.practicalxml.xpath.SimpleNamespaceResolver
 
SimpleXMLReader - Class in net.sf.practicalxml.util
An implementation of XMLReader based on XMLFilterImpl, which implements the parse() methods (default behavior of XMLFilterImpl is to delegate to a parent XMLReader, and throw NullPointerException if there is no parent).
SimpleXMLReader() - Constructor for class net.sf.practicalxml.util.SimpleXMLReader
Creates a new instance, using the default configuration of SAXParserFactory.
SimpleXMLReader(SAXParser) - Constructor for class net.sf.practicalxml.util.SimpleXMLReader
Creates a new instance, wrapping a pre-existing parser.
skippedEntity(String) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
startDocument() - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
startElement(String, String, String, Attributes) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
startPrefixMapping(String, String) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
stringify(Object) - Method in class net.sf.practicalxml.converter.internal.JavaStringConversions
Converts a Java primitive object to a string representation.
StringUtils - Class in net.sf.practicalxml.internal
Deprecated.
This class provides functionality that is available in KDGCommons (http://kdgcommons.sourceforge.net/) and Jakarta Commons. It will be removed in release 2.0.0.
StringUtils() - Constructor for class net.sf.practicalxml.internal.StringUtils
Deprecated.
 
stripIllegals(String) - Static method in class net.sf.practicalxml.XmlUtil
Removes all illegal characters from the passed string.

T

text(String) - Static method in class net.sf.practicalxml.builder.XmlBuilder
Creates a text node.
TextNode - Class in net.sf.practicalxml.builder
Holds element content.
TextNode(String) - Constructor for class net.sf.practicalxml.builder.TextNode
 
toDOM() - Method in class net.sf.practicalxml.builder.ElementNode
Generates a new DOM document with this element as the root.
toSAX(ContentHandler) - Method in class net.sf.practicalxml.builder.CommentNode
 
toSAX(ContentHandler) - Method in class net.sf.practicalxml.builder.ElementNode
Invokes the passed ContentHandler for this element and its children.
toSAX(ContentHandler) - Method in class net.sf.practicalxml.builder.Node
Invokes the passed ContentHandler for this element and its children.
toSAX(ContentHandler) - Method in class net.sf.practicalxml.builder.PINode
 
toSAX(ContentHandler) - Method in class net.sf.practicalxml.builder.TextNode
 
toStream(OutputStream) - Method in class net.sf.practicalxml.builder.ElementNode
Writes the tree rooted at this element to an OutputStream, using UTF-8 encoding, without a prologue or whitepspace between nodes.
toStream(OutputStream, String) - Method in class net.sf.practicalxml.builder.ElementNode
Writes the tree rooted at this element to an OutputStream, using a specified encoding, without a prologue or whitepspace between nodes.
toString() - Method in class net.sf.practicalxml.builder.ElementNode
Generates an XML string, where this node is the root element.
toString(int) - Method in class net.sf.practicalxml.builder.ElementNode
Generates an XML string, where this node is the root element.
toString() - Method in class net.sf.practicalxml.xpath.FunctionResolver
Returns a string that lists this resolver's functions, intended for debugging.
toString() - Method in class net.sf.practicalxml.xpath.NamespaceResolver
Returns a string containing the the xmlns attribute specifications that would result from this resolver.
toString() - Method in class net.sf.practicalxml.xpath.SimpleNamespaceResolver
Returns a string containing the the xmlns attribute specifications that would result from this resolver.
toString() - Method in class net.sf.practicalxml.xpath.XPathWrapper
The string value is the expression.
TransformerFactoryHelper - Class in net.sf.practicalxml.internal
This class hides implementation-specific details of output transformers.
TransformerFactoryHelper() - Constructor for class net.sf.practicalxml.internal.TransformerFactoryHelper
 
treeToString(Element, int) - Static method in class net.sf.practicalxml.OutputUtil
Debug dump of the e rooted at the specified element.
trimTextRecursive(Node) - Static method in class net.sf.practicalxml.DomUtil
Removes leading and trailing whitespace from all descendent text nodes.
trimToEmpty(String) - Static method in class net.sf.practicalxml.internal.StringUtils
Deprecated.
Trims all whitespace characters (as defined by Character.isWhitespace()) from both ends of the string, returning an empty string if there's nothing left.
TypeUtils - Class in net.sf.practicalxml.converter.internal
Constants and static methods for working with elements that declare their type using the {practicalxml}:type attribute (the actual namespace is defined in ConversionConstants).
TypeUtils() - Constructor for class net.sf.practicalxml.converter.internal.TypeUtils
 

U

unescape(String) - Static method in class net.sf.practicalxml.converter.internal.JsonUtils
Unescapes a string, replacing "slash-sequences" by actual characters.
unescape(String) - Static method in class net.sf.practicalxml.XmlUtil
Unescapes the passed string, converting the five XML entities (&amp;, &lt;, &gt;, &apos;, and &quot;) into their correspinding characters.
unparsedEntityDecl(String, String, String, String) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 
Uppercase - Class in net.sf.practicalxml.xpath.function
Converts the string value of its argument to uppercase, using a locale-aware conversion.
Uppercase() - Constructor for class net.sf.practicalxml.xpath.function.Uppercase
 

V

validateType(Element, Class<?>) - Static method in class net.sf.practicalxml.converter.internal.TypeUtils
Validates that the stated type of the element is assignable to the passed class.
validatingParse(InputSource, EntityResolver, ErrorHandler) - Static method in class net.sf.practicalxml.ParseUtil
Parses the supplied source with a namespace-aware, DTD-validating parser, using a caller-supplied error handler and entity resolver.
validatingParse(InputSource, ErrorHandler) - Static method in class net.sf.practicalxml.ParseUtil
Parses the supplied source with a namespace-aware, DTD-validating parser, using a caller-supplied error handler and default entity resolver.
validatingParse(InputSource, Schema, ErrorHandler) - Static method in class net.sf.practicalxml.ParseUtil
Parses the supplied source with a namespace-aware, XSD-validating parser, using a caller-supplied error handler and entity resolver.
valueOf(String) - Static method in enum net.sf.practicalxml.converter.bean.Bean2XmlOptions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.sf.practicalxml.converter.bean.Xml2BeanOptions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.sf.practicalxml.converter.json.Json2XmlOptions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.sf.practicalxml.converter.json.Xml2JsonOptions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.sf.practicalxml.xpath.XPathWrapperFactory.CacheType
Returns the enum constant of this type with the specified name.
values() - Static method in enum net.sf.practicalxml.converter.bean.Bean2XmlOptions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.practicalxml.converter.bean.Xml2BeanOptions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.practicalxml.converter.json.Json2XmlOptions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.practicalxml.converter.json.Xml2JsonOptions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.practicalxml.xpath.XPathWrapperFactory.CacheType
Returns an array containing the constants of this enum type, in the order they are declared.

W

warning(SAXParseException) - Method in class net.sf.practicalxml.util.ErrorHandlerAdapter
 
warning(SAXParseException) - Method in class net.sf.practicalxml.util.ExceptionErrorHandler
 
warning(SAXParseException) - Method in class net.sf.practicalxml.util.XMLFilterImplBridge
 

X

Xml2BeanConverter - Class in net.sf.practicalxml.converter.bean
Driver class for converting an XML DOM into a Java bean.
Xml2BeanConverter(Xml2BeanOptions...) - Constructor for class net.sf.practicalxml.converter.bean.Xml2BeanConverter
 
Xml2BeanOptions - Enum in net.sf.practicalxml.converter.bean
Options used by Xml2BeanConverter to control the way that DOM trees are translated to Java beans.
Xml2JsonConverter - Class in net.sf.practicalxml.converter.json
Handles the actual work of converting XML to JSON.
Xml2JsonConverter(Xml2JsonOptions...) - Constructor for class net.sf.practicalxml.converter.json.Xml2JsonConverter
 
Xml2JsonOptions - Enum in net.sf.practicalxml.converter.json
Options to control conversion from XML documents to JSON strings.
XmlBuilder - Class in net.sf.practicalxml.builder
A tool for building XML, avoiding the mistakes of simple text output and the hassle of the DOM API.
XmlBuilder() - Constructor for class net.sf.practicalxml.builder.XmlBuilder
 
XmlBuilderException - Exception in net.sf.practicalxml.builder
This exception is used both to report errors directly from the XmlBuilder code, as well as to wrap exceptions thrown from called code.
XmlBuilderException(String) - Constructor for exception net.sf.practicalxml.builder.XmlBuilderException
 
XmlBuilderException(String, Throwable) - Constructor for exception net.sf.practicalxml.builder.XmlBuilderException
 
XmlException - Exception in net.sf.practicalxml
An unchecked exception for use by the utility classes, typically to wrap a checked exception thrown the XML library.
XmlException(String) - Constructor for exception net.sf.practicalxml.XmlException
 
XmlException(String, Throwable) - Constructor for exception net.sf.practicalxml.XmlException
 
XmlException(Throwable) - Constructor for exception net.sf.practicalxml.XmlException
 
XMLFilterImplBridge - Class in net.sf.practicalxml.util
This class acts as a bridge between the DefaultHandler expected by SAXParser, and the XMLReader used by SAXSource.
XMLFilterImplBridge(XMLFilterImpl) - Constructor for class net.sf.practicalxml.util.XMLFilterImplBridge
 
XmlUtil - Class in net.sf.practicalxml
A collection of static methods for manipulating XML as text.
XmlUtil() - Constructor for class net.sf.practicalxml.XmlUtil
 
XPathWrapper - Class in net.sf.practicalxml.xpath
This class simplifies the use of XPath expressions, hiding the factory and return types, and providing a simple builder-style interface for adding resolvers.
XPathWrapper(String) - Constructor for class net.sf.practicalxml.xpath.XPathWrapper
Creates a new instance, which may then be customized with various resolvers, and used to evaluate expressions.
XPathWrapperFactory - Class in net.sf.practicalxml.xpath
A factory for producing XPathWrapper instances with the same configuration (namespace bindings and functions), reducing the amount of code needed when applying multiple expressions to the same complex XML.
XPathWrapperFactory() - Constructor for class net.sf.practicalxml.xpath.XPathWrapperFactory
Creates a factory that will always return new XPathWrapper instances.
XPathWrapperFactory(XPathWrapperFactory.CacheType) - Constructor for class net.sf.practicalxml.xpath.XPathWrapperFactory
Creates a factory that will optionally store XPathWrapper instances in a cache.
XPathWrapperFactory.CacheType - Enum in net.sf.practicalxml.xpath
Defines the various options for caching.
XSD_BASE64 - Static variable in class net.sf.practicalxml.converter.internal.TypeUtils
Type value indicating Base64 encoding.
XSD_HEXBINARY - Static variable in class net.sf.practicalxml.converter.internal.TypeUtils
Type value indicating hex encoding.
XSD_TYPE_PREFIX - Static variable in class net.sf.practicalxml.converter.internal.TypeUtils
Prefix for xsi:type values for elements holding primitive values as defined by XML Schema.
XsiBoolean - Class in net.sf.practicalxml.xpath.function
Converts its argument to a boolean value, using a modification of the rules for Schema instances: true is represented by the literal values "true" or 1, ignoring case, while false is everything else.
XsiBoolean() - Constructor for class net.sf.practicalxml.xpath.function.XsiBoolean
 
XsiUtil - Class in net.sf.practicalxml
A collection of static utility methods for updating/extracting the DOM with values defined by the XML Schema specification.
XsiUtil() - Constructor for class net.sf.practicalxml.XsiUtil
 
A B C D E F G H I J L N O P R S T U V W X