org.apache.jasper.xmlparser: public class: XMLString

org.apache.jasper.xmlparser
public class: XMLString [javadoc | source]

java.lang.Object
   org.apache.jasper.xmlparser.XMLString

Direct Known Subclasses:
XMLStringBuffer

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

author: Andy - Clark, IBM

version: $ - Id: XMLString.java 467222 2006-10-24 03:17:11Z markt $

Field Summary
public char[]	ch	The character array.
public int	offset	The offset into the character array.
public int	length	The length of characters from the offset.

Constructor:

Constructor:
public XMLString() { } Default constructor.
public XMLString(XMLString string) { setValues(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 XMLString(char[] ch, int offset, int length) { setValues(ch, offset, 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() {

}

Default constructor.

 public XMLString(XMLString string) {
        setValues(string);
}

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

Parameters:

string - The XMLString to copy.

 public XMLString(char[] ch,
    int offset,
    int length) {
        setValues(ch, offset, 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 from org.apache.jasper.xmlparser.XMLString Summary:
clear, equals, equals, setValues, setValues, toString

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.jasper.xmlparser.XMLString Detail:
public void clear() { this.ch = null; this.offset = 0; this.length = -1; } Resets all of the values to their defaults.
public boolean equals(String s) { if (s == null) { return false; } if ( length != s.length() ) { return false; } // is this faster than call s.toCharArray first and compare the // two arrays directly, which will possibly involve creating a // new char array object. for (int i=0; i< length; i++) { if (ch[offset+i] != s.charAt(i)) { return false; } } return true; } Returns true if the contents of this XMLString structure and the specified string are equal.
public boolean equals(char[] ch, int offset, int length) { if (ch == null) { return false; } if (this.length != length) { return false; } for (int i=0; i< length; i++) { if (this.ch[this.offset+i] != ch[offset+i] ) { return false; } } return true; } Returns true if the contents of this XMLString structure and the specified array are equal.
public void setValues(XMLString s) { setValues(s.ch, s.offset, s.length); } 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) { this.ch = ch; this.offset = offset; this.length = length; } Initializes the contents of the XMLString structure with the specified values.
public String toString() { return length > 0 ? new String(ch, offset, length) : ""; } Returns a string representation of this object.

Method from org.apache.jasper.xmlparser.XMLString Detail:

 public  void clear() {
        this.ch = null;
        this.offset = 0;
        this.length = -1;
}

Resets all of the values to their defaults.

 public boolean equals(String s) {
        if (s == null) {
            return false;
        }
        if ( length != s.length() ) {
            return false;
        }
        // is this faster than call s.toCharArray first and compare the 
        // two arrays directly, which will possibly involve creating a
        // new char array object.
        for (int i=0; i< length; i++) {
            if (ch[offset+i] != s.charAt(i)) {
                return false;
            }
        }
        return true;
}

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

 public boolean equals(char[] ch,
    int offset,
    int length) {
        if (ch == null) {
            return false;
        }
        if (this.length != length) {
            return false;
        }
        for (int i=0; i< length; i++) {
            if (this.ch[this.offset+i] != ch[offset+i] ) {
                return false;
            }
        }
        return true;
}

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

 public  void setValues(XMLString s) {
        setValues(s.ch, s.offset, s.length);
}

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) {
        this.ch = ch;
        this.offset = offset;
        this.length = length;
}

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

 public String toString() {
        return length  > 0 ? new String(ch, offset, length) : "";
}

Returns a string representation of this object.