XMLReader (axelframework 3.1.12.RELEASE API)

java.lang.Object
- org.xmlactions.common.xml.XMLReader

Direct Known Subclasses:: XMLParser

public class XMLReader
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field and Description

boolean debug

protected boolean ReadAll

Fields
Modifier and Type	Field and Description
`boolean`	`debug`
`protected boolean`	`ReadAll`

Constructor Summary

Constructors
Constructor and Description

XMLReader()

XMLReader(byte[] buffer)

Constructors
Constructor and Description
`XMLReader()`
`XMLReader(byte[] buffer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearErrorMessage()`
`int`	`countNodes(java.lang.String nodeName)` Counts the number of nodes matching nodeName
`protected boolean`	`equals(byte[] to)` Compare xml from current position to the param byte[] to
`protected boolean`	`equals(byte[] to, boolean terminator)` Compare xml from current position to the param byte[] to
`int`	`findEndElement(boolean both)` Find '</' or '/>
`int`	`findStartElement()` Find '<' todo allow cdata section <![CDATA[...]]>
`java.lang.String`	`getAttributeValue()` Get attribute value starting at curPos.
`java.lang.String`	`getAttributeValue(java.lang.String attributeName)`
`byte[]`	`getAttributeValueAsByte(java.lang.String attributeName)`
`byte[]`	`getAttributeValueAsByte(java.lang.String attributeName, boolean reset)`
`byte[]`	`getContent()`
`byte[]`	`getContent(java.lang.String elementName)`
`java.lang.String`	`getContentAsString()`
`java.lang.String`	`getContentAsString(java.lang.String elementName)`
`int`	`getCurPos()`
`byte[]`	`getElement(byte[] elementName)` find a matching element from the current position in the xml, return it's body from element start including < to element end.
`byte[]`	`getElement(byte[] elementName, int index)` find a matching element from the current position in the xml, return it's body from element start including < to element end.
`java.lang.String`	`getElementAttribute(java.lang.String elementName, java.lang.String elementAttributeName)`
`byte[]`	`getElementAttributeAsByte(java.lang.String elementName, java.lang.String elementAttributeName)`
`java.lang.String`	`getErrorMessage()`
`byte[]`	`getInnerElement(byte[] elementName)` find a matching element from the current position in the xml, return it's body from element start including < to element end.
`byte[]`	`getInnerElement(byte[] elementName, int index)` find a matching element from the current position in the xml, return it's body from element start including < to element end.
`int`	`getIntAttributeValue(java.lang.String attributeName)`
`int`	`getIntElementAttribute(java.lang.String elementName, java.lang.String elementAttributeName)`
`java.lang.String`	`getNextAttributeValue(java.lang.String attributeName)`
`XMLReader`	`getNode(java.lang.String nodeName)` find a matching element from the current position in the xml, return it's body from element start including < to element end.
`java.lang.String`	`getNodeAsString(java.lang.String nodeName)`
`int`	`getNodeEnd(byte[] nodeName)` find a matching element end from the current position in the xml, return it's ending position index including the >
`int`	`getNodeStart(byte[] nodeName)` find a matching element from the current position in the xml, return it's starting position index
`static boolean`	`isWhiteSpace(byte b)`
`boolean`	`isXMLNameChar(byte b)`
`static void`	`main(java.lang.String[] args)`
`byte`	`read()` Read a byte skipping any or any `<![CDATA[...]]>`
`byte[]`	`replaceAmps()`
`byte[]`	`replaceCDATA()` This will replace any and all CDATA sections within the reader.
`void`	`reset()`
`void`	`setCurPos(int pos)`
`void`	`skipNonWhiteSpace()` skip over non white space including ' ' 0x0a and 0x0d
`void`	`skipNonXMLName()` skip over non xml name characters for now these will be anything but whitespace \| & < > / ;
`void`	`skipWhiteSpace()` skip over white space including ' ' 0x0a and 0x0d
`void`	`skipXMLName()` skip over valid xml name characters for now these will be anything but whitespace \| & < > / ;

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - debug
```
public boolean debug
```
  - ReadAll
```
protected boolean ReadAll
```
- Constructor Detail
  - XMLReader
```
public XMLReader()
```
  - XMLReader
```
public XMLReader(byte[] buffer)
```
- Method Detail
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
  - clearErrorMessage
```
public void clearErrorMessage()
```
  - getCurPos
```
public int getCurPos()
```
  - setCurPos
```
public void setCurPos(int pos)
```
  - reset
```
public void reset()
```
  - read
```
public byte read()
          throws EndOfBufferException,
                 BadXMLException,
                 java.lang.Exception
```
    Read a byte skipping any or any <![CDATA[...]]>
    
    Returns:
    
    byte read or null
    
    Throws:
    
    EndOfBufferException
    
    BadXMLException
    
    java.lang.Exception
  - findStartElement
```
public int findStartElement()
```
    Find '<' todo allow cdata section <![CDATA[...]]>
    
    Returns:
    
    index where '<' found or -1 if not found
  - findEndElement
```
public int findEndElement(boolean both)
```
    Find '</' or '/>
    
    Returns:
    
    -1 for not found | 1 for found '<' | 2 for found '/>'
  - skipXMLName
```
public void skipXMLName()
```
    skip over valid xml name characters for now these will be anything but whitespace | & < > / ;
  - skipNonXMLName
```
public void skipNonXMLName()
```
    skip over non xml name characters for now these will be anything but whitespace | & < > / ;
  - skipWhiteSpace
```
public void skipWhiteSpace()
```
    skip over white space including ' ' 0x0a and 0x0d
  - skipNonWhiteSpace
```
public void skipNonWhiteSpace()
```
    skip over non white space including ' ' 0x0a and 0x0d
  - equals
```
protected boolean equals(byte[] to)
                  throws java.lang.Exception
```
    Compare xml from current position to the param byte[] to
    
    Parameters:
    
    to - is what we want to compare the xml buffer to.
    
    Returns:
    
    true if equals or false if not
    
    Throws:
    
    java.lang.Exception
  - equals
```
protected boolean equals(byte[] to,
                         boolean terminator)
                  throws java.lang.Exception
```
    Compare xml from current position to the param byte[] to
    
    Parameters:
    
    to - is what we want to compare the xml buffer to.
    
    terminator - if set true will force a check for a whitespace or = character at the end of the match.
    
    Returns:
    
    true if equals or false if not
    
    Throws:
    
    java.lang.Exception
  - isWhiteSpace
```
public static boolean isWhiteSpace(byte b)
```
  - isXMLNameChar
```
public boolean isXMLNameChar(byte b)
```
    Parameters:
    
    b - is the xml character we want to check
    
    Returns:
    
    true if character is a valid XML name character
  - getNodeStart
```
public int getNodeStart(byte[] nodeName)
```
    find a matching element from the current position in the xml, return it's starting position index
    
    Returns:
    
    -1 of not found
  - getNodeEnd
```
public int getNodeEnd(byte[] nodeName)
```
    find a matching element end from the current position in the xml, return it's ending position index including the >
    
    Returns:
    
    -1 if not found
  - getNode
```
public XMLReader getNode(java.lang.String nodeName)
```
    find a matching element from the current position in the xml, return it's body from element start including < to element end.
  - getNodeAsString
```
public java.lang.String getNodeAsString(java.lang.String nodeName)
```
  - getElement
```
public byte[] getElement(byte[] elementName)
```
    find a matching element from the current position in the xml, return it's body from element start including < to element end.
    
    Returns:
    
    element or -1 of not found
  - getElement
```
public byte[] getElement(byte[] elementName,
                         int index)
```
    find a matching element from the current position in the xml, return it's body from element start including < to element end.
    
    Returns:
    
    element or -1 of not found
  - getInnerElement
```
public byte[] getInnerElement(byte[] elementName)
```
    find a matching element from the current position in the xml, return it's body from element start including < to element end.
    
    Returns:
    
    element or -1 of not found
  - getInnerElement
```
public byte[] getInnerElement(byte[] elementName,
                              int index)
```
    find a matching element from the current position in the xml, return it's body from element start including < to element end.
    
    Returns:
    
    element or -1 of not found
  - getAttributeValue
```
public java.lang.String getAttributeValue(java.lang.String attributeName)
```
  - getAttributeValue
```
public java.lang.String getAttributeValue()
```
    Get attribute value starting at curPos. curPos is the ending position of the attribute name. From curPos we look for an '=' followed by '"' skipping any whitespace in between.
    
    Returns:
    
    the attribute value if found or null if not found
  - getNextAttributeValue
```
public java.lang.String getNextAttributeValue(java.lang.String attributeName)
```
  - getIntAttributeValue
```
public int getIntAttributeValue(java.lang.String attributeName)
                         throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getAttributeValueAsByte
```
public byte[] getAttributeValueAsByte(java.lang.String attributeName)
```
  - getAttributeValueAsByte
```
public byte[] getAttributeValueAsByte(java.lang.String attributeName,
                                      boolean reset)
```
  - getElementAttribute
```
public java.lang.String getElementAttribute(java.lang.String elementName,
                                            java.lang.String elementAttributeName)
```
  - getIntElementAttribute
```
public int getIntElementAttribute(java.lang.String elementName,
                                  java.lang.String elementAttributeName)
                           throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getElementAttributeAsByte
```
public byte[] getElementAttributeAsByte(java.lang.String elementName,
                                        java.lang.String elementAttributeName)
```
  - getContentAsString
```
public java.lang.String getContentAsString()
```
  - getContentAsString
```
public java.lang.String getContentAsString(java.lang.String elementName)
```
  - getContent
```
public byte[] getContent()
```
  - getContent
```
public byte[] getContent(java.lang.String elementName)
```
  - replaceCDATA
```
public byte[] replaceCDATA()
```
    This will replace any and all CDATA sections within the reader.
    
    Returns:
    
    the new content with the CDATA sections replaced.
  - replaceAmps
```
public byte[] replaceAmps()
```
  - countNodes
```
public int countNodes(java.lang.String nodeName)
```
    Counts the number of nodes matching nodeName
    
    Parameters:
    
    nodeName - name of nodes we want to count
    
    Returns:
    
    number of nodes matching nodeName
  - main
```
public static void main(java.lang.String[] args)
```

Class XMLReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

debug

ReadAll

Constructor Detail

XMLReader

XMLReader

Method Detail

getErrorMessage

clearErrorMessage

getCurPos

setCurPos

reset

read

findStartElement

findEndElement

skipXMLName

skipNonXMLName

skipWhiteSpace

skipNonWhiteSpace

equals

equals

isWhiteSpace

isXMLNameChar

getNodeStart

getNodeEnd

getNode

getNodeAsString

getElement

getElement

getInnerElement

getInnerElement

getAttributeValue

getAttributeValue

getNextAttributeValue

getIntAttributeValue

getAttributeValueAsByte

getAttributeValueAsByte

getElementAttribute

getIntElementAttribute

getElementAttributeAsByte

getContentAsString

getContentAsString

getContent

getContent

replaceCDATA

replaceAmps

countNodes

main