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

A

ALPHABET - Static variable in class xtom.parser.util.Base64

The 64 valid Base64 values.

Attribute - class xtom.parser.Attribute.

Description:this calss is a container for the attributes in the XMl element.

Attribute() - Constructor for class xtom.parser.Attribute

Attribute(String, String) - Constructor for class xtom.parser.Attribute

Creates a new attribute.
BY DEFAULT - names of the attributes are case sensitive

addAttribute(Attribute) - Method in class xtom.parser.Element

adds an attribute to this element.

addChildElement(Element) - Method in class xtom.parser.Element

adds a child element to this element.

addHandler(Handler) - Method in class xtom.parser.Parser

Adds a handler to the current logger.

addSlashes(String) - Static method in class xtom.parser.util.TextUtil

If the " and ' were removed, puts them back.

attributes - Variable in class xtom.parser.Element

Attributes of this element

B

BAD_ENCODING - Static variable in class xtom.parser.util.Base64

Base64 - class xtom.parser.util.Base64.

Encodes and decodes to and from Base64 notation.

Base64() - Constructor for class xtom.parser.util.Base64

Defeats instantiation.

Base64.InputStream - class xtom.parser.util.Base64.InputStream.

A Base64#InputStream will read data from another InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

Base64.InputStream(InputStream) - Constructor for class xtom.parser.util.Base64.InputStream

Constructs a Base64#InputStream in DECODE mode.

Base64.InputStream(InputStream, int) - Constructor for class xtom.parser.util.Base64.InputStream

Constructs a Base64#InputStream in either ENCODE or DECODE mode.

Base64.OutputStream - class xtom.parser.util.Base64.OutputStream.

A Base64#OutputStream will write data to another OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

Base64.OutputStream(OutputStream) - Constructor for class xtom.parser.util.Base64.OutputStream

Constructs a Base64#OutputStream in ENCODE mode.

Base64.OutputStream(OutputStream, int) - Constructor for class xtom.parser.util.Base64.OutputStream

Constructs a Base64#OutputStream in either ENCODE or DECODE mode.

b4 - Variable in class xtom.parser.util.Base64.OutputStream

breakLines - Variable in class xtom.parser.util.Base64.InputStream

breakLines - Variable in class xtom.parser.util.Base64.OutputStream

buffer - Variable in class xtom.parser.util.Base64.InputStream

buffer - Variable in class xtom.parser.util.Base64.OutputStream

bufferLength - Variable in class xtom.parser.util.Base64.InputStream

bufferLength - Variable in class xtom.parser.util.Base64.OutputStream

C

capitalizedFirstLetters(String) - Static method in class xtom.parser.util.TextUtil

Takes the text consiting of one to many words, and converts first letter of each word to a UpperCase letter and the rest of the letters of the word are converted to the LowerCase.

caseSensitive - Variable in class xtom.parser.Element

Used to specify whether the names of elements are case sensitive

caseSensitive - Variable in class xtom.parser.XMLTree

Sets the sensitivity of element names, default true

characters(char[], int, int) - Method in class xtom.parser.Parser

children - Variable in class xtom.parser.Element

Children of this Element

close() - Method in class xtom.parser.util.Base64.OutputStream

Flushes and closes (I think, in the superclass) the stream.

current - Static variable in class xtom.parser.Parser

D

DECODABET - Static variable in class xtom.parser.util.Base64

Translates a Base64 value to either its 6-bit reconstruction value or a negative number indicating some other meaning.

DECODE - Static variable in class xtom.parser.util.Base64

Specify decoding.

DONT_BREAK_LINES - Static variable in class xtom.parser.util.Base64

Don't break lines when encoding (violates strict Base64 specification)

decode(byte[], int, int) - Static method in class xtom.parser.util.Base64

Very low-level access to decoding ASCII characters in the form of a byte array.

decode(String) - Static method in class xtom.parser.util.Base64

Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.

decode4to3(byte[]) - Static method in class xtom.parser.util.Base64

Decodes the first four bytes of array fourBytes and returns an array up to three bytes long with the decoded values.

decode4to3(byte[], int, byte[], int) - Static method in class xtom.parser.util.Base64

Decodes four bytes from array source and writes the resulting bytes (up to three of them) to destination.

decodeToObject(String) - Static method in class xtom.parser.util.Base64

Attempts to decode Base64 data and deserialize a Java Object within.

E

ENCODE - Static variable in class xtom.parser.util.Base64

Specify encoding.

EQUALS_SIGN - Static variable in class xtom.parser.util.Base64

The equals sign (=) as a byte.

EQUALS_SIGN_ENC - Static variable in class xtom.parser.util.Base64

Element - class xtom.parser.Element.

Description:Each xml tag is an element.

Element() - Constructor for class xtom.parser.Element

Element(String, String) - Constructor for class xtom.parser.Element

Creates a new Element object.
BY DEFAULT - ELEMENT NAMES ARE CASE SENSITIVE
The case sensitivity can be turned of by XMLTree.

ePath - Variable in class xtom.parser.MultipleElementInstancesException

encode - Variable in class xtom.parser.util.Base64.InputStream

encode - Variable in class xtom.parser.util.Base64.OutputStream

encode3to4(byte[]) - Static method in class xtom.parser.util.Base64

Encodes the first three bytes of array threeBytes and returns a four-byte array in Base64 notation.

encode3to4(byte[], int) - Static method in class xtom.parser.util.Base64

Encodes up to the first three bytes of array threeBytes and returns a four-byte array in Base64 notation.

encode3to4(byte[], byte[], int) - Static method in class xtom.parser.util.Base64

Encodes up to the first three bytes of array threeBytes and returns a four-byte array in Base64 notation.

encode3to4(byte[], int, int, byte[], int) - Static method in class xtom.parser.util.Base64

Encodes up to three bytes of the array source and writes the resulting four Base64 bytes to destination.

encodeBytes(byte[]) - Static method in class xtom.parser.util.Base64

Encodes a byte array into Base64 notation.

encodeBytes(byte[], int) - Static method in class xtom.parser.util.Base64

Encodes a byte array into Base64 notation.

encodeBytes(byte[], int, int) - Static method in class xtom.parser.util.Base64

Encodes a byte array into Base64 notation.

encodeBytes(byte[], int, int, int) - Static method in class xtom.parser.util.Base64

Encodes a byte array into Base64 notation.

encodeObject(Serializable) - Static method in class xtom.parser.util.Base64

Serializes an object and returns the Base64-encoded version of that serialized object.

encodeObject(Serializable, int) - Static method in class xtom.parser.util.Base64

Serializes an object and returns the Base64-encoded version of that serialized object.

endElement(String, String, String) - Method in class xtom.parser.Parser

ex - Variable in class xtom.parser.Parser

F

findChildElements(String) - Method in class xtom.parser.Element

Searches the list of the children of this element to find the correct one specified by the name.

flushBase64() - Method in class xtom.parser.util.Base64.OutputStream

Method added by PHIL.

G

GZIP - Static variable in class xtom.parser.util.Base64

Specify that data should be gzip-compressed.

generateXMLAttributes(StringBuffer, Element) - Method in class xtom.parser.XMLTree

Generates Attribute XML markup for this element.

generateXMLChildren(StringBuffer, Element) - Method in class xtom.parser.XMLTree

Generates XML markup for this element.

getAttribute(String) - Method in class xtom.parser.Element

Gets an attribute specified by a name.

getAttributes() - Method in class xtom.parser.Element

getChildren() - Method in class xtom.parser.Element

getElementByPath(String) - Method in class xtom.parser.Element

This method gets the element according to the path specidied.

getElementPath() - Method in class xtom.parser.MultipleElementInstancesException

Returns the path to the element in root/element1/element2 form.

getElements(String) - Method in class xtom.parser.Element

This method is one the does the searching of the Element specified in the path.

getElementsByPath(String) - Method in class xtom.parser.Element

This method gets all instances of specified element according to the path specidied.

getException() - Method in class xtom.parser.Parser

getMessage() - Method in class xtom.parser.ParserIOException

getName() - Method in class xtom.parser.Attribute

getName() - Method in class xtom.parser.Element

getParentElement() - Method in class xtom.parser.Element

Returns the parent Element.

getParentElement() - Method in class xtom.parser.MultipleElementInstancesException

Returns the Parent Element, which has multiple children.

getRootElement() - Method in class xtom.parser.XMLTree

getThrowable() - Method in class xtom.parser.ParserIOException

getValue() - Method in class xtom.parser.Attribute

getValue() - Method in class xtom.parser.Element

getValueAsBoolean() - Method in class xtom.parser.Attribute

Returns value parsed as a boolean.

getValueAsBoolean() - Method in class xtom.parser.Element

Returns value parsed as a boolean.

getValueAsByte() - Method in class xtom.parser.Attribute

Returns value parsed as a byte.

getValueAsByte() - Method in class xtom.parser.Element

Returns value parsed as a byte.

getValueAsCharacter() - Method in class xtom.parser.Attribute

Returns value parsed as a char.

getValueAsCharacter() - Method in class xtom.parser.Element

Returns value parsed as a char.

getValueAsDouble() - Method in class xtom.parser.Attribute

Returns value parsed as a double.

getValueAsDouble() - Method in class xtom.parser.Element

Returns value parsed as a double.

getValueAsFloat() - Method in class xtom.parser.Attribute

Returns value parsed as a float.

getValueAsFloat() - Method in class xtom.parser.Element

Returns value parsed as a float.

getValueAsInt() - Method in class xtom.parser.Attribute

Returns value parsed as an int.

getValueAsInt() - Method in class xtom.parser.Element

Returns value parsed as an int.

getValueAsLong() - Method in class xtom.parser.Attribute

Returns value parsed as a float.

getValueAsLong() - Method in class xtom.parser.Element

Returns value parsed as a float.

getValueAsShort() - Method in class xtom.parser.Attribute

Returns value parsed as a short.

getValueAsShort() - Method in class xtom.parser.Element

Returns value parsed as a short.

getXMLTree() - Method in class xtom.parser.Parser

The tree is saved in memory for as long as Parser lives.

H

hasAttribute(String) - Method in class xtom.parser.Element

Checks if the attribute exists.

hasAttributes() - Method in class xtom.parser.Element

hasChildren() - Method in class xtom.parser.Element

I

in - Variable in class xtom.parser.Parser

isCaseSensitive() - Method in class xtom.parser.Element

isCaseSensitive() - Method in class xtom.parser.XMLTree

isNameTheSame(String, String) - Method in class xtom.parser.Element

This method check if the two string Names are the same, it Check to see if case sensitive is set, and if it is, it converts both names toLowercase.

L

lineLength - Variable in class xtom.parser.util.Base64.InputStream

lineLength - Variable in class xtom.parser.util.Base64.OutputStream

logException(Exception) - Method in class xtom.parser.Parser

Logs the exception to the specified Handler

logger - Variable in class xtom.parser.Parser

M

MAX_LINE_LENGTH - Static variable in class xtom.parser.util.Base64

Maximum line length (76) of Base64 output.

MissingRootElementException - exception xtom.parser.MissingRootElementException.

Description:

MissingRootElementException(String) - Constructor for class xtom.parser.MissingRootElementException

MultipleElementInstancesException - exception xtom.parser.MultipleElementInstancesException.

Description:

MultipleElementInstancesException(String, String, Element) - Constructor for class xtom.parser.MultipleElementInstancesException

Creates a new exception, which is used to tell the developer that there are multiple elements of the same name that corresponed to that path.

N

NEW_LINE - Static variable in class xtom.parser.util.Base64

The new line character (\n) as a byte.

NO_OPTIONS - Static variable in class xtom.parser.util.Base64

No options specified.

name - Variable in class xtom.parser.Attribute

name - Variable in class xtom.parser.Element

name of this element

numSigBytes - Variable in class xtom.parser.util.Base64.InputStream

O

options - Variable in class xtom.parser.util.Base64.InputStream

options - Variable in class xtom.parser.util.Base64.OutputStream

out - Static variable in class xtom.parser.Parser

P

PREFERRED_ENCODING - Static variable in class xtom.parser.util.Base64

Preferred encoding.

Parser - class xtom.parser.Parser.

Description: This is a main parser that will be responsible for parsing XML string into an XMLTree.

Parser() - Constructor for class xtom.parser.Parser

Parser(String) - Constructor for class xtom.parser.Parser

Default parser.

Parser(InputStream) - Constructor for class xtom.parser.Parser

Default parser.

ParserIOException - exception xtom.parser.ParserIOException.

Description: This is a wrapper class for a Throwable Instance.

ParserIOException(Throwable) - Constructor for class xtom.parser.ParserIOException

parent - Variable in class xtom.parser.Element

Parent element - used by the parser

parentElement - Variable in class xtom.parser.MultipleElementInstancesException

parse() - Method in class xtom.parser.Parser

Main Parser method
This parser only checks if the xml is well formed, meaning that each tag has a closing tag.

parse(InputStream) - Method in class xtom.parser.Parser

This is the method that will do actual parsing.

position - Variable in class xtom.parser.util.Base64.InputStream

position - Variable in class xtom.parser.util.Base64.OutputStream

previous - Static variable in class xtom.parser.Parser

printAttributes(StringBuffer, Element) - Method in class xtom.parser.XMLTree

Prints attributes to the XMLBuffer for display.

printChildren(StringBuffer, Element, int) - Method in class xtom.parser.XMLTree

Prints children to the XML Buffer for display.

printStackTrace() - Method in class xtom.parser.ParserIOException

printTabs(int) - Method in class xtom.parser.XMLTree

Helper method to print tabs.

printTree(OutputStream) - Method in class xtom.parser.XMLTree

Prints an String representation of the tree to a specified outputstream.

R

read() - Method in class xtom.parser.util.Base64.InputStream

Reads enough of the input stream to convert to/from Base64 and returns the next byte.

read(byte[], int, int) - Method in class xtom.parser.util.Base64.InputStream

Calls Base64.InputStream.read() repeatedly until the end of stream is reached or len bytes are read.

resumeEncoding() - Method in class xtom.parser.util.Base64.OutputStream

Resumes encoding of the stream.

root - Static variable in class xtom.parser.Parser

rootElement - Variable in class xtom.parser.XMLTree

Root element of the XML document

S

searchTerms - Variable in class xtom.parser.XMLTree

setCaseSensitive(boolean) - Method in class xtom.parser.Element

Sets the case sensitivity to all of the children Elements of this element.

setCaseSensitive(boolean) - Method in class xtom.parser.XMLTree

Sets the whole tree to be case sensitive or not.

setLoggingLevel(Level) - Method in class xtom.parser.Parser

Sets the level for Logging Default Logging Level is WARNING

setParentElement(Element) - Method in class xtom.parser.Element

Sets the parent for this element, only used by the parser

setUpLogging() - Method in class xtom.parser.Parser

Sets up the Logging for the Parser.

setValue(String) - Method in class xtom.parser.Element

This is called by the Parser class, to set the value.

startElement(String, String, String, Attributes) - Method in class xtom.parser.Parser

stripSlashes(String) - Static method in class xtom.parser.util.TextUtil

Strips ' and " from the String to make sure that SQL statement doesn't produce any errors.

suspendEncoding - Variable in class xtom.parser.util.Base64.OutputStream

suspendEncoding() - Method in class xtom.parser.util.Base64.OutputStream

Suspends encoding of the stream.

T

TextUtil - class xtom.parser.util.TextUtil.

This class contains a number of helper methods used for manipulating the strings.

TextUtil() - Constructor for class xtom.parser.util.TextUtil

t - Variable in class xtom.parser.ParserIOException

toString() - Method in class xtom.parser.Attribute

toString() - Method in class xtom.parser.Element

Outputs the Name and value of the method, and attributes

toString() - Method in class xtom.parser.XMLTree

The toString method returns toXML() generated xml

toXML() - Method in class xtom.parser.XMLTree

Generates an XML document from an existing tree.

tree - Variable in class xtom.parser.Parser

U

UnknownAttributeException - exception xtom.parser.UnknownAttributeException.

Description:

UnknownAttributeException(String) - Constructor for class xtom.parser.UnknownAttributeException

UnknownElementException - exception xtom.parser.UnknownElementException.

Description:

UnknownElementException(String) - Constructor for class xtom.parser.UnknownElementException

V

value - Variable in class xtom.parser.Attribute

value - Variable in class xtom.parser.Element

value of this element, null if the element is a parent

W

WHITE_SPACE_ENC - Static variable in class xtom.parser.util.Base64

write(int) - Method in class xtom.parser.util.Base64.OutputStream

Writes the byte to the output stream after converting to/from Base64 notation.

write(byte[], int, int) - Method in class xtom.parser.util.Base64.OutputStream

Calls write(int) repeatedly until len bytes are written.

X

XMLTree - class xtom.parser.XMLTree.

Description: The XMLTree is the model representation of the XML document.

XMLTree() - Constructor for class xtom.parser.XMLTree

XMLTree(Element) - Constructor for class xtom.parser.XMLTree

Creates a new XMLTree

xml - Variable in class xtom.parser.Parser

xtom.parser - package xtom.parser

xtom.parser.util - package xtom.parser.util

_

_NATIVE_ALPHABET - Static variable in class xtom.parser.util.Base64

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