Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javapoint.xml
Class XMLUtilities

java.lang.Object
  extended by javapoint.xml.XMLUtilities

public class XMLUtilities
extends java.lang.Object

Nested Class Summary
static class XMLUtilities.MultiException
           
 
Method Summary
static void addAttribute(org.w3c.dom.Document document, org.w3c.dom.Node context, java.lang.String attrName, java.lang.String attrValue)
           
static org.w3c.dom.Element appendChild(org.w3c.dom.Element parent, java.lang.String tagName)
           
static org.w3c.dom.Element appendChild(org.w3c.dom.Node parent, java.lang.String tagName)
           
static java.lang.String attribute(java.lang.String name, java.lang.String value)
           
static java.lang.String cdata(java.lang.String text)
           
static java.lang.String end(java.lang.String name)
           
static java.lang.String escape(java.lang.Character character)
           
static java.lang.String escape(java.lang.String text)
           
static java.lang.String escape(java.lang.String text, java.lang.Character... characters)
           
static java.lang.Object getArticles(org.w3c.dom.Node parent, java.lang.Object... path)
           
static java.lang.Object getAttribute(java.lang.Object parent, java.lang.String attributeName)
           
static java.lang.String getDefaultNodeName(java.lang.Short xmlNodeType)
           
static short getDefaultNodeType(java.lang.String pathElement)
           
static org.w3c.dom.Node getElementByIndex(java.lang.Object parent, int index)
           
static org.w3c.dom.NodeList getElementsByTagName(java.lang.Object parent, java.lang.String tagName)
           
static org.w3c.dom.Node getNode(org.w3c.dom.Node parent, java.lang.Object... path)
           
static org.w3c.dom.Node getNode(org.w3c.dom.Node context, java.lang.String xPath)
           
static java.util.List<org.w3c.dom.Node> getNodes(org.w3c.dom.Node context, java.lang.String xPath)
           
static org.w3c.dom.Node getOrCreateNode(org.w3c.dom.Node context, java.lang.String xPath)
           
static org.w3c.dom.Node getOrCreateNode(org.w3c.dom.Node context, java.lang.String xPath, java.lang.String defaultXMLContents)
           
static org.w3c.dom.Document getOwnerDocument(org.w3c.dom.Node node)
           
static javax.xml.transform.Source getResourceAsSource(java.lang.String resourceName)
           
static java.lang.String getTextContents(java.lang.Object parent)
           
static java.lang.String getXMLContents(java.lang.Object parent)
           
static org.w3c.dom.Document newDocument()
           
static org.w3c.dom.Document normalize(org.w3c.dom.Document document)
           
static org.w3c.dom.Document parse(org.xml.sax.InputSource inputSource)
           
static org.w3c.dom.Document parse(java.io.InputStream xmlInputStream)
           
static org.w3c.dom.Document parse(java.lang.String xmlInput)
           
static org.w3c.dom.NodeList parseFragment(java.lang.String xmlFragment)
           
static java.awt.Color readColor(org.w3c.dom.Node context, java.lang.String xPath)
           
static int readInt(org.w3c.dom.Node context, java.lang.String xPath)
           
static java.lang.String readString(org.w3c.dom.Node context, java.lang.String xPath)
           
static java.lang.String start(java.lang.String name, java.lang.String... attributeNameAndValues)
           
static java.lang.String startEnd(java.lang.String name, java.lang.String... attributeNameAndValues)
           
static java.lang.String toString(java.lang.Short xmlNodeType)
           
static java.util.List<java.lang.Throwable> validate(java.io.InputStream xmlInputStream, javax.xml.transform.Source dtdOrSchema)
           
static void write(org.w3c.dom.Node node, java.io.File outputFile)
           
static void write(org.w3c.dom.Node node, java.io.File outputFile, int indent)
           
static void write(org.w3c.dom.Node node, javax.xml.transform.Result output, int indent)
           
static void write(java.lang.Object object, org.w3c.dom.Node parent, java.lang.String childElementName)
           
static java.lang.String xml(java.lang.String version, java.lang.String encoding, java.lang.String... moreAttributes)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getNodes

public static final java.util.List<org.w3c.dom.Node> getNodes(org.w3c.dom.Node context,
                                                              java.lang.String xPath)
Parameters:
context -
Not null
xPath -
Not null
Returns:

Not null

getNode

public static final org.w3c.dom.Node getNode(org.w3c.dom.Node context,
                                             java.lang.String xPath)
Parameters:
context -
Not null
xPath -
Not null
Returns:

Maybe null
Not New

getOrCreateNode

public static final org.w3c.dom.Node getOrCreateNode(org.w3c.dom.Node context,
                                                     java.lang.String xPath,
                                                     java.lang.String defaultXMLContents)
Parameters:
context -
Not null
Input-output
xPath -
Not null
defaultXMLContents -
Not null
Returns:

Not null
Maybe new

addAttribute

public static final void addAttribute(org.w3c.dom.Document document,
                                      org.w3c.dom.Node context,
                                      java.lang.String attrName,
                                      java.lang.String attrValue)

getOrCreateNode

public static final org.w3c.dom.Node getOrCreateNode(org.w3c.dom.Node context,
                                                     java.lang.String xPath)
Parameters:
context -
Not null
Input-output
xPath -
Not null
Returns:

Not null
Maybe new

write

public static final void write(java.lang.Object object,
                               org.w3c.dom.Node parent,
                               java.lang.String childElementName)

toString

public static final java.lang.String toString(java.lang.Short xmlNodeType)
Parameters:
xmlNodeType -
Maybe null
Range: any Short
Returns:

Not null
Maybe new

getDefaultNodeName

public static final java.lang.String getDefaultNodeName(java.lang.Short xmlNodeType)
Parameters:
xmlNodeType -
Maybe null
Range: { Node.ATTRIBUTE_NODE, Node.PROCESSING_INSTRUCTION_NODE, Node.COMMENT_NODE, Node.DOCUMENT_NODE, Node.DOCUMENT_FRAGMENT_NODE, Node.TEXT_NODE, Node.CDATA_SECTION_NODE, Node.ELEMENT_NODE, null }
Returns:

Not null
Not new

getDefaultNodeType

public static final short getDefaultNodeType(java.lang.String pathElement)
Parameters:
pathElement -
Not null
Returns:

Range: { Node.ATTRIBUTE_NODE, Node.PROCESSING_INSTRUCTION_NODE, Node.COMMENT_NODE, Node.DOCUMENT_NODE, Node.DOCUMENT_FRAGMENT_NODE, Node.TEXT_NODE, Node.CDATA_SECTION_NODE, Node.ELEMENT_NODE }

newDocument

public static final org.w3c.dom.Document newDocument()
Returns:

Not null
New

normalize

public static final org.w3c.dom.Document normalize(org.w3c.dom.Document document)
Parameters:
document -
Not null
Input-output
Returns:
document
Not null

write

public static final void write(org.w3c.dom.Node node,
                               java.io.File outputFile)
Parameters:
node -
Not null
outputFile -
Not null
Input-output

write

public static final void write(org.w3c.dom.Node node,
                               java.io.File outputFile,
                               int indent)
Parameters:
node -
Not null
outputFile -
Not null
Input-output
indent -
Range: [0 .. Integer.MAX_VALUE]

write

public static final void write(org.w3c.dom.Node node,
                               javax.xml.transform.Result output,
                               int indent)
Parameters:
node -
Not null
output -
Not null
Input-output
indent -
Range: [0 .. Integer.MAX_VALUE]

parseFragment

public static final org.w3c.dom.NodeList parseFragment(java.lang.String xmlFragment)
                                                throws org.xml.sax.SAXException,
                                                       java.io.IOException,
                                                       javax.xml.parsers.ParserConfigurationException
Parameters:
xmlFragment -
Not null
Returns:

Not null
New
Throws:
org.xml.sax.SAXException
java.io.IOException
javax.xml.parsers.ParserConfigurationException

parse

public static final org.w3c.dom.Document parse(java.lang.String xmlInput)
                                        throws org.xml.sax.SAXException,
                                               java.io.IOException,
                                               javax.xml.parsers.ParserConfigurationException
Parameters:
xmlInput -
Not null
Returns:

Not null
New
Throws:
org.xml.sax.SAXException
java.io.IOException
javax.xml.parsers.ParserConfigurationException

parse

public static final org.w3c.dom.Document parse(java.io.InputStream xmlInputStream)
                                        throws org.xml.sax.SAXException,
                                               java.io.IOException,
                                               javax.xml.parsers.ParserConfigurationException
Parameters:
xmlInputStream -
Not null
Input-output
Returns:

Not null
New
Throws:
org.xml.sax.SAXException
java.io.IOException
javax.xml.parsers.ParserConfigurationException

parse

public static final org.w3c.dom.Document parse(org.xml.sax.InputSource inputSource)
                                        throws org.xml.sax.SAXException,
                                               java.io.IOException,
                                               javax.xml.parsers.ParserConfigurationException
Parameters:
inputSource -
Not null
Input-output
Returns:

Not null
New
Throws:
org.xml.sax.SAXException
java.io.IOException
javax.xml.parsers.ParserConfigurationException

appendChild

public static final org.w3c.dom.Element appendChild(org.w3c.dom.Element parent,
                                                    java.lang.String tagName)
Parameters:
parent -
Not null
Input-output
tagName -
Not null
Shared
Returns:

Not null
New

appendChild

public static final org.w3c.dom.Element appendChild(org.w3c.dom.Node parent,
                                                    java.lang.String tagName)

getXMLContents

public static final java.lang.String getXMLContents(java.lang.Object parent)
Parameters:
parent -
Not null
Returns:

Not null
New

getTextContents

public static final java.lang.String getTextContents(java.lang.Object parent)
Parameters:
parent -
Not null
Returns:

Not null
Maybe new

getAttribute

public static final java.lang.Object getAttribute(java.lang.Object parent,
                                                  java.lang.String attributeName)
Parameters:
parent -
Not null
attributeName -
Not null
Returns:

Maybe null
Maybe new

getArticles

public static final java.lang.Object getArticles(org.w3c.dom.Node parent,
                                                 java.lang.Object... path)
Parameters:
parent -
Not null
path -
Not null
Returns:

Maybe null
Maybe new

getNode

public static final org.w3c.dom.Node getNode(org.w3c.dom.Node parent,
                                             java.lang.Object... path)
Parameters:
parent -
Not null
path -
Not null
Returns:

Maybe null
Maybe new

getOwnerDocument

public static final org.w3c.dom.Document getOwnerDocument(org.w3c.dom.Node node)
Parameters:
node -
Not null
Returns:

Maybe null

getElementsByTagName

public static final org.w3c.dom.NodeList getElementsByTagName(java.lang.Object parent,
                                                              java.lang.String tagName)
Parameters:
parent -
Not null
tagName -
Not null
Returns:

Not null
Throws:
java.lang.IllegalArgumentException - if parent is not a DOM document, element or node list

getElementByIndex

public static final org.w3c.dom.Node getElementByIndex(java.lang.Object parent,
                                                       int index)
Parameters:
parent -
Not null
index -
Range: [0 .. Integer.MAX_VALUE]
Returns:

Maybe null
Maybe new
Throws:
java.lang.IllegalArgumentException - if parent is not a DOM document, element or node list

escape

public static final java.lang.String escape(java.lang.String text)
Parameters:
text -
Not null
Returns:

Not null
Maybe new

escape

public static final java.lang.String escape(java.lang.String text,
                                            java.lang.Character... characters)
Parameters:
text -
Not null
characters -
Not null
Returns:

Not null
Maybe new

escape

public static final java.lang.String escape(java.lang.Character character)
Parameters:
character - IN NOT_NULL
Returns:
NEW NOT_NULL

cdata

public static final java.lang.String cdata(java.lang.String text)
Parameters:
text - IN NOT_NULL
Returns:
NEW NOT_NULL

validate

public static final java.util.List<java.lang.Throwable> validate(java.io.InputStream xmlInputStream,
                                                                 javax.xml.transform.Source dtdOrSchema)
Parameters:
xmlInputStream -
Not null
dtdOrSchema -
Not null
Returns:

Not null
New

getResourceAsSource

public static final javax.xml.transform.Source getResourceAsSource(java.lang.String resourceName)
Parameters:
resourceName - IN NOT_NULL
Returns:
NEW NOT_NULL

xml

public static final java.lang.String xml(java.lang.String version,
                                         java.lang.String encoding,
                                         java.lang.String... moreAttributes)
Parameters:
version - IN MAYBE_NULL
encoding - IN MAYBE_NULL
moreAttributes - IN NOT_NULL
Returns:
NEW NOT_NULL

startEnd

public static final java.lang.String startEnd(java.lang.String name,
                                              java.lang.String... attributeNameAndValues)
Parameters:
name - IN NOT_NULL
attributeNameAndValues - IN NOT_NULL
Returns:
NEW NOT_NULL

start

public static final java.lang.String start(java.lang.String name,
                                           java.lang.String... attributeNameAndValues)
Parameters:
name - IN NOT_NULL
attributeNameAndValues - IN NOT_NULL
Returns:
NEW NOT_NULL

end

public static final java.lang.String end(java.lang.String name)
Parameters:
name - IN NOT_NULL
Returns:
MAYBE_NEW NOT_NULL

attribute

public static final java.lang.String attribute(java.lang.String name,
                                               java.lang.String value)
Parameters:
name - IN NOT_NULL
value - IN NOT_NULL
Returns:
NEW NOT_NULL

readInt

public static final int readInt(org.w3c.dom.Node context,
                                java.lang.String xPath)

readColor

public static final java.awt.Color readColor(org.w3c.dom.Node context,
                                             java.lang.String xPath)

readString

public static final java.lang.String readString(org.w3c.dom.Node context,
                                                java.lang.String xPath)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD