public class

XMLString

extends Object
java.lang.Object
   ↳ org.apache.xerces.xni.XMLString
Known Direct Subclasses

Class Overview

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.

Summary

Fields
public char[] ch The character array.
public int length The length of characters from the offset.
public int offset The offset into the character array.
Public Constructors
XMLString()
Default constructor.
XMLString(char[] ch, int offset, int length)
Constructs an XMLString structure preset with the specified values.
XMLString(XMLString string)
Constructs an XMLString structure with copies of the values in the given structure.
Public Methods
void clear()
Resets all of the values to their defaults.
boolean equals(char[] ch, int offset, int length)
Returns true if the contents of this XMLString structure and the specified array are equal.
boolean equals(String s)
Returns true if the contents of this XMLString structure and the specified string are equal.
void setValues(XMLString s)
Initializes the contents of the XMLString structure with copies of the given string structure.
void setValues(char[] ch, int offset, int length)
Initializes the contents of the XMLString structure with the specified values.
String toString()
Returns a string representation of this object.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public char[] ch

The character array.

public int length

The length of characters from the offset.

public int offset

The offset into the character array.

Public Constructors

public XMLString ()

Default constructor.

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.

public XMLString (XMLString string)

Constructs an XMLString structure with copies of the values in the given structure.

Note: This does not copy the character array; only the reference to the array is copied.

Parameters
string The XMLString to copy.

Public Methods

public void clear ()

Resets all of the values to their defaults.

public boolean equals (char[] ch, int offset, int length)

Returns true if the contents of this XMLString structure and the specified array are equal.

Parameters
ch The character array.
offset The offset into the character array.
length The length of characters from the offset.

public boolean equals (String s)

Returns true if the contents of this XMLString structure and the specified string are equal.

Parameters
s The string to compare.

public void setValues (XMLString s)

Initializes the contents of the XMLString structure with copies of the given string structure.

Note: This does not copy the character array; only the reference to the array is copied.

public void setValues (char[] ch, int offset, int length)

Initializes the contents of the XMLString structure with the specified values.

Parameters
ch The character array.
offset The offset into the character array.
length The length of characters from the offset.

public String toString ()

Returns a string representation of this object.