org.htmlunit.cyberneko.xerces.xni

Class XMLString

java.lang.Object

org.htmlunit.cyberneko.xerces.xni.XMLString

public class XMLString
extends Object

This class is used as a structure to pass text contained in the underlying character buffer of the scanner. The offset and length fields allow the buffer to be re-used without creating new character arrays.

Note: Methods that are passed an XMLString structure should consider the contents read-only and not make any modifications to the contents of the buffer. The method receiving this structure should also not modify the offset and length if this structure (or the values of this structure) are passed to another method.

Note: Methods that are passed an XMLString structure are required to copy the information out of the buffer if it is to be saved for use beyond the scope of the method. The contents of the structure are volatile and the contents of the character buffer cannot be assured once the method that is passed this structure returns. Therefore, methods passed this structure should not save any reference to the structure or the character array contained in the structure.

Author:

Eric Ye, IBM, Andy Clark, IBM, Ronald Brill

Constructor Summary

Constructors

Constructor and Description
XMLString() Constructs an XMLString.
XMLString(char[] ch, int offset, int length) Constructs an XMLString structure preset with the specified values.

Method Summary

Modifier and Type	Method and Description
void	append(char c)
void	append(char[] str, int offset, int len)
void	append(String str)
void	append(XMLString xmlStr)
void	appendTo(StringBuilder stringBuilder)
void	characters(ContentHandler contentHandler)
char	charAt(int index)
XMLString	clear() Resets.
XMLString	clone()
void	comment(LexicalHandler lexicalHandler)
void	delete(int start, int end)
boolean	endsWith(String string)
char[]	getChars() Deprecated.
void	ignorableWhitespace(ContentHandler contentHandler)
boolean	isWhitespace()
int	length()
void	reduceToContent(String startMarker, String endMarker)
String	toString()
void	trimWhitespaceAtEnd()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XMLString

public XMLString()

Constructs an XMLString.

XMLString

public XMLString(char[] ch,
                 int offset,
                 int length)

Constructs an XMLString structure preset with the specified values.

Parameters:

ch - The character array.

offset - The offset into the character array.

length - The length of characters from the offset.

Method Detail

append

public void append(char c)

append

public void append(String str)

append

public void append(XMLString xmlStr)

append

public void append(char[] str,
                   int offset,
                   int len)

charAt

public char charAt(int index)

length

public int length()

endsWith

public boolean endsWith(String string)

reduceToContent

public void reduceToContent(String startMarker,
                            String endMarker)

getChars

@Deprecated
public char[] getChars()

Deprecated.

clone

public XMLString clone()

Overrides:

clone in class Object

clear

public XMLString clear()

Resets.

isWhitespace

public boolean isWhitespace()

trimWhitespaceAtEnd

public void trimWhitespaceAtEnd()

delete

public void delete(int start,
                   int end)

appendTo

public void appendTo(StringBuilder stringBuilder)

toString

public String toString()

Overrides:

toString in class Object

characters

public void characters(ContentHandler contentHandler)
                throws SAXException

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(ContentHandler contentHandler)
                         throws SAXException

Throws:

SAXException

comment

public void comment(LexicalHandler lexicalHandler)
             throws SAXException

Throws:

SAXException