A C D E F G I M N O P R S T W X

A

addSimpleImportHandler(SimpleImportHandler) - Method in class org.apache.commons.xmlio.in.SimpleImporter

Adds a new callback handler if it is not in the callback list, yet.

C

callbackHandlerList - Variable in class org.apache.commons.xmlio.in.SimpleImporter

cData(SimplePath, String) - Method in class org.apache.commons.xmlio.in.DefaultSimpleImportHandler

cData(SimplePath, String) - Method in interface org.apache.commons.xmlio.in.SimpleImportHandler

Is called back when the parser has found character data.

ConversionHelpers - Class in org.apache.commons.xmlio.in

Collection of some simple conversion and fallback methods for convenience.

ConversionHelpers() - Constructor for class org.apache.commons.xmlio.in.ConversionHelpers

create() - Static method in class org.apache.commons.xmlio.out.XMLStringWriter

Creates a new XMLStringWriter objects.

createEmptyTag(String) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating an empty tag having no attributes.

createEmptyTag(String, String[], String[]) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating an empty tag.

createEmptyTag(String, String, String) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating an empty tag.

createEmptyTag(String, String[][]) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating an empty tag.

createEmptyTag(String, Attributes) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating an empty tag.

createEndTag(String) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating an end tag.

createStartTag(String) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating a start tag having no attributes.

createStartTag(String, String[], String[], boolean) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating a start tag.

createStartTag(String, String[], String[]) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating a non empty start tag.

createStartTag(String, String, String, boolean) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating a start tag.

createStartTag(String, String, String) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating a non empty start tag.

createStartTag(String, String[], String[], boolean, boolean, char) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating a start tag.

createStartTag(String, String[][], boolean) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating a start tag.

createStartTag(String, String[][]) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating a non empty start tag.

createStartTag(String, String[][], boolean, boolean, char) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating a start tag.

createStartTag(String, Attributes) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating a start tag.

createStartTag(String, Attributes, boolean) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating a start tag.

createStartTag(String, Attributes, boolean, boolean, char) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating a start tag.

currentElement - Variable in class org.apache.commons.xmlio.in.SimpleImporter

currentMixedPCData - Variable in class org.apache.commons.xmlio.in.SimpleImporter

D

debugBuffer - Variable in class org.apache.commons.xmlio.in.SimpleImporter

DefaultSimpleImportHandler - Class in org.apache.commons.xmlio.in

Empty implementation for callback interface SimpleImportHandler for SimpleImporter.

DefaultSimpleImportHandler() - Constructor for class org.apache.commons.xmlio.in.DefaultSimpleImportHandler

depth - Variable in class org.apache.commons.xmlio.out.XMLWriter

Current depth of the tree.

E

ENCODING_ISO_8859_1 - Static variable in class org.apache.commons.xmlio.out.XMLOutputStreamWriter

Name of ISO-8859-1 encoding

ENCODING_ISO_LATIN1 - Static variable in class org.apache.commons.xmlio.out.XMLOutputStreamWriter

Alias for ISO-8859-1 encoding

ENCODING_STANDARD - Static variable in class org.apache.commons.xmlio.out.XMLOutputStreamWriter

Name of standard encoding

ENCODING_UTF_16 - Static variable in class org.apache.commons.xmlio.out.XMLOutputStreamWriter

Name of UTF-16 encoding

ENCODING_UTF_8 - Static variable in class org.apache.commons.xmlio.out.XMLOutputStreamWriter

Name of UTF-8 encoding

encodingName - Variable in class org.apache.commons.xmlio.out.XMLOutputStreamWriter

endDocument() - Method in class org.apache.commons.xmlio.in.DefaultSimpleImportHandler

endDocument() - Method in interface org.apache.commons.xmlio.in.SimpleImportHandler

Is called back when the parsed document ends.

endElement(SimplePath, String) - Method in class org.apache.commons.xmlio.in.DefaultSimpleImportHandler

endElement(SimplePath, String) - Method in interface org.apache.commons.xmlio.in.SimpleImportHandler

Is called back when the parser has found the end of an element.

equals(Object) - Method in class org.apache.commons.xmlio.in.Item

equals(Object) - Method in class org.apache.commons.xmlio.in.SimplePath

F

factory - Variable in class org.apache.commons.xmlio.in.SimpleImporter

firstPCData - Variable in class org.apache.commons.xmlio.in.SimpleImporter

foundMixedPCData - Variable in class org.apache.commons.xmlio.in.SimpleImporter

G

generateAndWriteElementWithCData(XMLWriter, String, String[][], String) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating and writing a whole element.

generateAndWriteElementWithCData(XMLWriter, String, String[], String[], String) - Static method in class org.apache.commons.xmlio.out.XMLWriter

Convenience method for creating and writing a whole element.

getBoolean(String, boolean) - Static method in class org.apache.commons.xmlio.in.ConversionHelpers

Gets boolean value from a string value.

getBuildComplexPath() - Method in class org.apache.commons.xmlio.in.SimpleImporter

Determines if the simple path created will have complex additional info.

getEncodingName() - Method in class org.apache.commons.xmlio.out.XMLOutputStreamWriter

Gets the name of the encoding as it would be inserted into the XML declaration.

getFoundMixedPCData() - Method in class org.apache.commons.xmlio.in.SimpleImporter

Determines if we have found any mixed content while parsing.

getFullDebugMode() - Method in class org.apache.commons.xmlio.in.SimpleImporter

Gets the property described in SimpleImporter.setFullDebugMode(boolean).

getIncludeLeadingCDataIntoStartElementCallback() - Method in class org.apache.commons.xmlio.in.SimpleImporter

Gets property telling importer to return any leading CDATA, i.e.

getInt(String) - Static method in class org.apache.commons.xmlio.in.ConversionHelpers

Gets int value from a string value.

getInt(String, int) - Static method in class org.apache.commons.xmlio.in.ConversionHelpers

Gets int value from a string value.

getLong(String) - Static method in class org.apache.commons.xmlio.in.ConversionHelpers

Gets long value from a string value.

getLong(String, long) - Static method in class org.apache.commons.xmlio.in.ConversionHelpers

Gets long value from a string value.

getMakeCopy() - Method in class org.apache.commons.xmlio.in.SimpleImporter

Gets the property describing if every callback handler gets a fresh copy of the parsed data.

getName() - Method in class org.apache.commons.xmlio.in.Item

getNamespaceURI() - Method in class org.apache.commons.xmlio.in.Item

getNlAfterEmptyTag() - Method in class org.apache.commons.xmlio.out.XMLWriter

Gets property described in XMLWriter.setNlAfterEmptyTag(boolean).

getNlAfterEndTag() - Method in class org.apache.commons.xmlio.out.XMLWriter

Gets property described in XMLWriter.setNlAfterEndTag(boolean).

getNlAfterStartTag() - Method in class org.apache.commons.xmlio.out.XMLWriter

Gets property described in XMLWriter.setNlAfterStartTag(boolean).

getParsedStreamForDebug() - Method in class org.apache.commons.xmlio.in.SimpleImporter

Gets the whole stream parsed in the SimpleImporter.parse(org.xml.sax.InputSource) method.

getPrettyPrintMode() - Method in class org.apache.commons.xmlio.out.XMLWriter

Gets property described in XMLWriter.setPrettyPrintMode(boolean).

getString(String, String) - Static method in class org.apache.commons.xmlio.in.ConversionHelpers

Returns value if not null, otherwise fallBack.

getTabWidth() - Method in class org.apache.commons.xmlio.out.XMLWriter

Gets property described in XMLWriter.setTabWidth(int).

getTrimContent() - Method in class org.apache.commons.xmlio.in.SimpleImporter

Sets the property described in SimpleImporter.setTrimContent(boolean).

getUseQName() - Method in class org.apache.commons.xmlio.in.SimpleImporter

Determines if the path shall be assembled of the full qualified names.

getZeroLengthIsNull() - Method in class org.apache.commons.xmlio.in.SimpleImporter

Gets property: When findind zero length content should it be treated as null data? If it is treated as null data nothing is reported to handlers when finding zero length data.

I

indent - Variable in class org.apache.commons.xmlio.out.XMLWriter

Current indentation.

isCompatibleWithCDATABlock(String) - Static method in class org.apache.commons.xmlio.out.XMLEncode

Can this text be stored into a CDATA block?

isFirstPCData - Variable in class org.apache.commons.xmlio.in.SimpleImporter

isWhiteSpace(String) - Static method in class org.apache.commons.xmlio.out.XMLEncode

Checks if this text purely consists of the white space characters ' ', TAB, NEWLINE.

isXMLDeclarationWritten() - Method in class org.apache.commons.xmlio.out.XMLWriter

Indicates whether the XML declaration has been written, yet.

Item - Class in org.apache.commons.xmlio.in

Represntation of a path element.

Item() - Constructor for class org.apache.commons.xmlio.in.Item

Item(String) - Constructor for class org.apache.commons.xmlio.in.Item

Item(String, String) - Constructor for class org.apache.commons.xmlio.in.Item

ITEM_ANY - Static variable in class org.apache.commons.xmlio.in.Item

M

matches(Item) - Method in class org.apache.commons.xmlio.in.SimplePath

Checks if an item matches the last segment of this path.

matches(Item[], boolean) - Method in class org.apache.commons.xmlio.in.SimplePath

Checks if the given array of items matches this path.

matches(Item[]) - Method in class org.apache.commons.xmlio.in.SimplePath

Checks if the given array of items matches this path.

matches(SimplePath) - Method in class org.apache.commons.xmlio.in.SimplePath

Finds out if the the given path matches this one.

matches(String) - Method in class org.apache.commons.xmlio.in.SimplePath

Finds out if the path represented by the given string matches this one.

matchesFromRoot(Item[]) - Method in class org.apache.commons.xmlio.in.SimplePath

Checks if the given array of items matches this path from the root.

matchsAny(Collection) - Method in class org.apache.commons.xmlio.in.SimplePath

Checks if this path matches any of the paths stored in paths collection.

matchsAny(String[]) - Method in class org.apache.commons.xmlio.in.SimplePath

Checks if this path matches any of the paths stored in paths collection.

N

needsEncoding(String) - Static method in class org.apache.commons.xmlio.out.XMLEncode

Checks if this text needs encoding in order to be represented in XML.

needsEncoding(String, boolean) - Static method in class org.apache.commons.xmlio.out.XMLEncode

Checks if this text needs encoding in order to be represented in XML.

NEWLINE - Static variable in class org.apache.commons.xmlio.out.XMLWriter

nlAfterEmptyTag - Variable in class org.apache.commons.xmlio.out.XMLWriter

nlAfterEndTag - Variable in class org.apache.commons.xmlio.out.XMLWriter

nlAfterStartTag - Variable in class org.apache.commons.xmlio.out.XMLWriter

NO_NEWLINE - Static variable in class org.apache.commons.xmlio.out.XMLWriter

O

org.apache.commons.xmlio.in - package org.apache.commons.xmlio.in

SimpleImporter

org.apache.commons.xmlio.out - package org.apache.commons.xmlio.out

os - Variable in class org.apache.commons.xmlio.out.XMLOutputStreamWriter

P

parse(InputSource) - Method in class org.apache.commons.xmlio.in.SimpleImporter

Parses the input source using the standard SAX parser and calls back the callback handlers.

parseStack - Variable in class org.apache.commons.xmlio.in.SimpleImporter

parseUrlOrFile(String) - Method in class org.apache.commons.xmlio.in.SimpleImporter

Tries to parse the file or URL named by parameter urlOrFileName.

path - Variable in class org.apache.commons.xmlio.in.SimplePath

pathList - Variable in class org.apache.commons.xmlio.in.SimplePath

prettyPrintMode - Variable in class org.apache.commons.xmlio.out.XMLWriter

R

removeSimpleImportHandler(SimpleImportHandler) - Method in class org.apache.commons.xmlio.in.SimpleImporter

Removes a callback handler if it is in the callback list.

S

setBuildComplexPath(boolean) - Method in class org.apache.commons.xmlio.in.SimpleImporter

Sets if the simple path created will have complex additional info.

setFullDebugMode(boolean) - Method in class org.apache.commons.xmlio.in.SimpleImporter

Sets the full debug mode which enables us to get the parsed stream as string via the SimpleImporter.getParsedStreamForDebug() method even if an error occured.

setIncludeLeadingCDataIntoStartElementCallback(boolean) - Method in class org.apache.commons.xmlio.in.SimpleImporter

Sets the property described in SimpleImporter.getIncludeLeadingCDataIntoStartElementCallback().

setMakeCopy(boolean) - Method in class org.apache.commons.xmlio.in.SimpleImporter

Sets the property described in SimpleImporter.getMakeCopy().

setNlAfterEmptyTag(boolean) - Method in class org.apache.commons.xmlio.out.XMLWriter

Sets if a newline is inserted after an empty start element by default.

setNlAfterEndTag(boolean) - Method in class org.apache.commons.xmlio.out.XMLWriter

Sets if a newline is inserted after an end tag by default.

setNlAfterStartTag(boolean) - Method in class org.apache.commons.xmlio.out.XMLWriter

Sets if a newline is inserted after a non empty start tag by default.

setPrettyPrintMode(boolean) - Method in class org.apache.commons.xmlio.out.XMLWriter

Switches on/off pretty print mode.

setTabWidth(int) - Method in class org.apache.commons.xmlio.out.XMLWriter

Sets the amount of spaces to increase indentation with element level.

setTrimContent(boolean) - Method in class org.apache.commons.xmlio.in.SimpleImporter

Sets when all content shall be trimed.

setUseQName(boolean) - Method in class org.apache.commons.xmlio.in.SimpleImporter

Sets if the path shall be assembled of the full qualified names.

setXMLDeclarationWritten(boolean) - Method in class org.apache.commons.xmlio.out.XMLWriter

Manually sets or resets whether XML declaration has been written.

setZeroLengthIsNull(boolean) - Method in class org.apache.commons.xmlio.in.SimpleImporter

Sets the property described in SimpleImporter.getZeroLengthIsNull().

SimpleImporter - Class in org.apache.commons.xmlio.in

Simple and fast importer for XML configuration or import files.

SimpleImporter() - Constructor for class org.apache.commons.xmlio.in.SimpleImporter

Creates a new SimpleImporter object having default property settings.

SimpleImporterException - Exception in org.apache.commons.xmlio.in

Tells us that there is something wrong with SimpleImporter.

SimpleImporterException(String) - Constructor for exception org.apache.commons.xmlio.in.SimpleImporterException

SimpleImportHandler - Interface in org.apache.commons.xmlio.in

Callback interface for SimpleImporter.

SimplePath - Class in org.apache.commons.xmlio.in

Rudimentary representation of a path to an XML element.

SimplePath(String) - Constructor for class org.apache.commons.xmlio.in.SimplePath

Creates a path object from a string describing it.

SimplePath(String, Item[]) - Constructor for class org.apache.commons.xmlio.in.SimplePath

Creates a path object from a string describing it.

SimplePath(SimplePath) - Constructor for class org.apache.commons.xmlio.in.SimplePath

Copy ctor.

startDocument() - Method in class org.apache.commons.xmlio.in.DefaultSimpleImportHandler

startDocument() - Method in interface org.apache.commons.xmlio.in.SimpleImportHandler

Is called back when the parsed document begins.

startElement(SimplePath, String, AttributesImpl, String) - Method in class org.apache.commons.xmlio.in.DefaultSimpleImportHandler

startElement(SimplePath, String, AttributesImpl, String) - Method in interface org.apache.commons.xmlio.in.SimpleImportHandler

Is called back when the parser has found the start of an element.

stripEndingSlash(String) - Static method in class org.apache.commons.xmlio.in.SimplePath

Strips off ending slash from a string if there is one.

T

tabWidth - Variable in class org.apache.commons.xmlio.out.XMLWriter

toString() - Method in class org.apache.commons.xmlio.in.Item

toString() - Method in class org.apache.commons.xmlio.in.SimplePath

toString() - Method in class org.apache.commons.xmlio.out.XMLStringWriter

Gets the string representation of your written XML.

W

writeCData(String) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeCData(String) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes character data with encoding.

writeComment(String) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeComment(String) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes comment encoded as comment.

writeElementWithCData(String, String, String) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeElementWithCData(String, String, String) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes a full element consisting of a start tag, character data and an end tag.

writeElementWithPCData(String, String, String) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeElementWithPCData(String, String, String) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes a full element consisting of a start tag, character data and an end tag.

writeEmptyElement(String, boolean) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeEmptyElement(String) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeEmptyElement(String, boolean) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes an empty element.

writeEmptyElement(String) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes an empty element.

writeEndTag(String, boolean) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeEndTag(String) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeEndTag(String, boolean) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes an end tag.

writeEndTag(String) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes an end tag.

writeNl() - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeNl() - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes a single newline.

writePCData(String) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writePCData(String) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes character data without encoding.

writePI(String, String) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writePI(String, String) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes a processing instruction.

writeProlog(String) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeProlog(String) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes prolog data like doctype delcaration and DTD parts followed by a newline.

writeStartTag(String, boolean) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeStartTag(String) - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeStartTag(String, boolean) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes a start tag.

writeStartTag(String) - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes a start tag.

writeXMLDeclaration() - Method in class org.apache.commons.xmlio.out.XMLOutputStreamWriter

Writes XML delcaration using version 1.0 and encoding specified in constructor.

writeXMLDeclaration() - Method in class org.apache.commons.xmlio.out.XMLStringWriter

writeXMLDeclaration() - Method in class org.apache.commons.xmlio.out.XMLWriter

Writes XML declaration.

X

xmlDeclWritten - Variable in class org.apache.commons.xmlio.out.XMLWriter

Flag indicating if the XML declaration has already been writter.

xmlDecodeTextToCDATA(String) - Static method in class org.apache.commons.xmlio.out.XMLEncode

Make CDATA out of possibly encoded PCDATA.

XMLEncode - Class in org.apache.commons.xmlio.out

Collection of XML encoding/decoding helpers.

XMLEncode() - Constructor for class org.apache.commons.xmlio.out.XMLEncode

xmlEncodeText(String) - Static method in class org.apache.commons.xmlio.out.XMLEncode

Encodes text as XML in the most suitable way, either CDATA block or PCDATA.

xmlEncodeTextAsCDATABlock(String) - Static method in class org.apache.commons.xmlio.out.XMLEncode

Returns string as CDATA block if possible, otherwise null.

xmlEncodeTextAsPCDATA(String) - Static method in class org.apache.commons.xmlio.out.XMLEncode

Encodes any text as PCDATA.

xmlEncodeTextAsPCDATA(String, boolean) - Static method in class org.apache.commons.xmlio.out.XMLEncode

Encodes any text as PCDATA.

xmlEncodeTextAsPCDATA(String, boolean, char) - Static method in class org.apache.commons.xmlio.out.XMLEncode

Encodes any text as PCDATA.

xmlEncodeTextForAttribute(String, char) - Static method in class org.apache.commons.xmlio.out.XMLEncode

Makes any text fit into XML attributes.

XMLOutputStreamWriter - Class in org.apache.commons.xmlio.out

Adds XML export functionality to the underlying output stream.

XMLOutputStreamWriter(OutputStream, String) - Constructor for class org.apache.commons.xmlio.out.XMLOutputStreamWriter

Creates a new output stream writer for XML export.

XMLOutputStreamWriter(OutputStream) - Constructor for class org.apache.commons.xmlio.out.XMLOutputStreamWriter

Creates a new output stream writer for XML export.

XMLStringWriter - Class in org.apache.commons.xmlio.out

This is a convenience class for writing XML to a string.

XMLWriter - Class in org.apache.commons.xmlio.out

FilterWriter adding formatted and encoded XML export functionality to the underlying writer.

XMLWriter(Writer) - Constructor for class org.apache.commons.xmlio.out.XMLWriter

Creates a new filter writer for XML export.

A C D E F G I M N O P R S T W X