C D E G H I L P S T V X

C

clear() - Method in class com.thebuzzmedia.sjxp.XMLParser.Location
Used to clear all the internal state of the location.
com.thebuzzmedia.sjxp - package com.thebuzzmedia.sjxp
 
com.thebuzzmedia.sjxp.rule - package com.thebuzzmedia.sjxp.rule
 

D

DEBUG - Static variable in class com.thebuzzmedia.sjxp.XMLParser
Flag used to indicate if debugging output has been enabled by setting the "sjxp.debug" system property to true.
DefaultRule<T> - Class in com.thebuzzmedia.sjxp.rule
Class used to provide a default implementation of a rule in SJXP.
DefaultRule(IRule.Type, String, String...) - Constructor for class com.thebuzzmedia.sjxp.rule.DefaultRule
Create a new rule with the given values.
doEndDocument(T) - Method in class com.thebuzzmedia.sjxp.XMLParser
Used to process a XmlPullParser.END_DOCUMENT event.
doEndTag(T) - Method in class com.thebuzzmedia.sjxp.XMLParser
Used to process a XmlPullParser.END_TAG event.
doParse(T) - Method in class com.thebuzzmedia.sjxp.XMLParser
Uses the underlying XmlPullParser to begin parsing through the XML content from the given stream.
doStartTag(T) - Method in class com.thebuzzmedia.sjxp.XMLParser
Used to process a XmlPullParser.START_TAG event.
doText(T) - Method in class com.thebuzzmedia.sjxp.XMLParser
Used to process a XmlPullParser.TEXT event.

E

ENABLE_NAMESPACES - Static variable in class com.thebuzzmedia.sjxp.XMLParser
Flag used to indicate if this parser should be namespace-aware by setting the "sjxp.namespaces" system property to true.
ENABLE_VALIDATION - Static variable in class com.thebuzzmedia.sjxp.XMLParser
Flag used to indicate if this parser should validate the parsed XML against the references DTD or XML Schema by setting the "sjxp.validation" system property to true.

G

getAttributeNames() - Method in class com.thebuzzmedia.sjxp.rule.DefaultRule
 
getAttributeNames() - Method in interface com.thebuzzmedia.sjxp.rule.IRule
Used to get a list of attribute names that are to be parsed from the element located at IRule.getLocationPath().
getCachedHashCode() - Method in class com.thebuzzmedia.sjxp.XMLParser.Location
Used to get a cached Integer version of the int XMLParser.Location.hashCode() return value.
getLocationPath() - Method in class com.thebuzzmedia.sjxp.rule.DefaultRule
 
getLocationPath() - Method in interface com.thebuzzmedia.sjxp.rule.IRule
Used to get the location path of the element inside the XML document that this rule is interested in.
getType() - Method in class com.thebuzzmedia.sjxp.rule.DefaultRule
 
getType() - Method in interface com.thebuzzmedia.sjxp.rule.IRule
Used to get the type of the rule.

H

handleParsedAttribute(XMLParser<T>, int, String, T) - Method in class com.thebuzzmedia.sjxp.rule.DefaultRule
Default no-op implementation.
handleParsedAttribute(XMLParser<T>, int, String, T) - Method in interface com.thebuzzmedia.sjxp.rule.IRule
Handler method called by the XMLParser when an IRule of type IRule.Type.ATTRIBUTE matches the parser's current location in the document.
handleParsedCharacters(XMLParser<T>, String, T) - Method in class com.thebuzzmedia.sjxp.rule.DefaultRule
Default no-op implementation.
handleParsedCharacters(XMLParser<T>, String, T) - Method in interface com.thebuzzmedia.sjxp.rule.IRule
Handler method called by the XMLParser when an IRule of type IRule.Type.CHARACTER matches the parser's current location in the document.
handleTag(XMLParser<T>, boolean, T) - Method in class com.thebuzzmedia.sjxp.rule.DefaultRule
Default no-op implementation.
handleTag(XMLParser<T>, boolean, T) - Method in interface com.thebuzzmedia.sjxp.rule.IRule
Handler method called by the XMLParser when an IRule of type IRule.Type.TAG matches the parser's current location in the document.
hashCode() - Method in class com.thebuzzmedia.sjxp.XMLParser.Location
Overridden to calculate the hash code of this location using the exact same hash code calculation that String.hashCode() uses.

I

initRules(IRule<T>...) - Method in class com.thebuzzmedia.sjxp.XMLParser
 
IRule<T> - Interface in com.thebuzzmedia.sjxp.rule
Interface used to describe a "rule" in SJXP.
IRule.Type - Enum in com.thebuzzmedia.sjxp.rule
Used to describe the type of the parse rule.

L

log(String, Object...) - Static method in class com.thebuzzmedia.sjxp.XMLParser
Helper method used to ensure a message is loggable before it is logged and then pre-pend a universal prefix to all log messages generated by this library to make the log entries easy to parse visually or programmatically.
LOG_MESSAGE_PREFIX - Static variable in class com.thebuzzmedia.sjxp.XMLParser
Prefix to every log message this library logs.

P

parse(InputStream) - Method in class com.thebuzzmedia.sjxp.XMLParser
Parse the XML out of the given stream matching the IRules provided when the XMLParser was instantiated.
parse(InputStream, T) - Method in class com.thebuzzmedia.sjxp.XMLParser
Parse the XML out of the given stream matching the IRules provided when the XMLParser was instantiated.
parse(InputStream, String) - Method in class com.thebuzzmedia.sjxp.XMLParser
Parse the XML out of the given stream (producing content matching the given encoding) matching the IRules provided when the XMLParser was instantiated.
parse(InputStream, String, T) - Method in class com.thebuzzmedia.sjxp.XMLParser
Parse the XML out of the given stream (producing content matching the given encoding) matching the IRules provided when the XMLParser was instantiated.
pop() - Method in class com.thebuzzmedia.sjxp.XMLParser.Location
"Pops" the last pushed path element off the "stack" by re-adjusting the StringBuilder's length to what it was before the last element was appended.
push(String, String) - Method in class com.thebuzzmedia.sjxp.XMLParser.Location
"Pushes" a new local name and optional namespace URI onto the "stack" by appending it to the current location path that represents the parser's location inside of the XML doc.

S

stop() - Method in class com.thebuzzmedia.sjxp.XMLParser
Used to indicate to the parser that you would like it to stop parsing.

T

toString() - Method in class com.thebuzzmedia.sjxp.rule.DefaultRule
Overridden to provide a nicely formatted representation of the rule for easy debugging.
toString() - Method in class com.thebuzzmedia.sjxp.XMLParser
Overridden to provide a nicely formatted representation of the parser for easy debugging.

V

valueOf(String) - Static method in enum com.thebuzzmedia.sjxp.rule.IRule.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.thebuzzmedia.sjxp.rule.IRule.Type
Returns an array containing the constants of this enum type, in the order they're declared.

X

XMLParser<T> - Class in com.thebuzzmedia.sjxp
Class used to define a parser that makes parsing using the performance of an XML Pull Parser with the ease of XPath-like expressions possible.
XMLParser(IRule<T>...) - Constructor for class com.thebuzzmedia.sjxp.XMLParser
Create a new parser that uses the given IRules when parsing any XML content.
XMLParser.Location - Class in com.thebuzzmedia.sjxp
Simple and fast class used to mock the behavior of a stack in the form of a string for the purposes of "pushing" and "popping" the parser's current location within an XML document as it processes START and END_TAG events.
XMLParser.Location() - Constructor for class com.thebuzzmedia.sjxp.XMLParser.Location
Creates a new empty location.
XMLParserException - Exception in com.thebuzzmedia.sjxp
Unchecked exception used to unify and report everything that can go wrong during an XML parse.
XMLParserException(String) - Constructor for exception com.thebuzzmedia.sjxp.XMLParserException
Create a new exception with the given message.
XMLParserException(String, Exception) - Constructor for exception com.thebuzzmedia.sjxp.XMLParserException
Create a new exception with the given message and cause.
XPP_FACTORY - Static variable in class com.thebuzzmedia.sjxp.XMLParser
Singleton XmlPullParserFactory instance used to create new underlying XmlPullParser instances for each instance of XMLParser.

C D E G H I L P S T V X
Copyright 2011 The Buzz Media, LLC