| org.apache.xpath.objects.XObject
 org.apache.xpath.objects.XString
org.apache.xpath.objects.XStringForFSB
| XStringForFSB | | public class XStringForFSB extends XString (Code) | | This class will wrap a FastStringBuffer and allow for
|
| Method Summary | |
| public void | appendToFsb(org.apache.xml.utils.FastStringBuffer fsb)
Cast result object to a string. | | public char | charAt(int index)
Returns the character at the specified index. | | public int | compareTo(XMLString xstr)
Compares two strings lexicographically.
Parameters:
xstr - the String to be compared. | | public int | compareToIgnoreCase(XMLString xstr)
Compares two strings lexicographically, ignoring case considerations.
This method returns an integer whose sign is that of
this.toUpperCase().toLowerCase().compareTo(
str.toUpperCase().toLowerCase()).
Note that this method does not take locale into account,
and will result in an unsatisfactory ordering for certain locales.
The java.text package provides collators to allow
locale-sensitive ordering.
Parameters:
xstr - the String to be compared. | | public XMLString | concat(String str)
Concatenates the specified string to the end of this string.
Parameters:
str - the String that is concatenated to the endof this String. | | public void | dispatchAsComment(org.xml.sax.ext.LexicalHandler lh)
Directly call the
comment method on the passed LexicalHandler for the
string-value. | | public void | dispatchCharactersEvents(org.xml.sax.ContentHandler ch)
Directly call the
characters method on the passed ContentHandler for the
string-value. | | public boolean | equals(XMLString obj2)
Compares this string to the specified object.
The result is true if and only if the argument is not
null and is a String object that represents
the same sequence of characters as this object.
Parameters:
obj2 - the object to compare this Stringagainst. | | public boolean | equals(XObject obj2)
Tell if two objects are functionally equal. | | public boolean | equals(String anotherString)
Tell if two objects are functionally equal. | | public boolean | equals(Object obj2)
Compares this string to the specified object.
The result is true if and only if the argument is not
null and is a String object that represents
the same sequence of characters as this object.
Parameters:
obj2 - the object to compare this Stringagainst. | | public boolean | equalsIgnoreCase(String anotherString)
Compares this String to another String,
ignoring case considerations. | | public XMLString | fixWhiteSpace(boolean trimHead, boolean trimTail, boolean doublePunctuationSpaces)
Conditionally trim all leading and trailing whitespace in the specified String. | | public FastStringBuffer | fsb()
Cast result object to a string. | | public void | getChars(int srcBegin, int srcEnd, char dst, int dstBegin)
Copies characters from this string into the destination character
array. | | public boolean | hasString()
Tell if this object contains a java String object. | | public int | hashCode()
Returns a hashcode for this string. | | public int | indexOf(int ch)
Returns the index within this string of the first occurrence of the
specified character. | | public int | indexOf(int ch, int fromIndex)
Returns the index within this string of the first occurrence of the
specified character, starting the search at the specified index.
If a character with value ch occurs in the character
sequence represented by this String object at an index
no smaller than fromIndex, then the index of the first
such occurrence is returned--that is, the smallest value k
such that:
(this.charAt(k) == ch) && (k >= fromIndex)
is true. | | public int | length()
Returns the length of this string. | | public Object | object()
Since this object is incomplete without the length and the offset, we
have to convert to a string when this function is called. | | public boolean | startsWith(XMLString prefix, int toffset)
Tests if this string starts with the specified prefix beginning
a specified index.
Parameters:
prefix - the prefix.
Parameters:
toffset - where to begin looking in the string. | | public boolean | startsWith(XMLString prefix)
Tests if this string starts with the specified prefix.
Parameters:
prefix - the prefix. | | public String | str()
Cast result object to a string. | | public XMLString | substring(int beginIndex)
Returns a new string that is a substring of this string. | | public XMLString | substring(int beginIndex, int endIndex)
Returns a new string that is a substring of this string. | | public double | toDouble()
Convert a string to a double -- Allowed input is in fixed
notation ddd.fff.
%OPT% CHECK PERFORMANCE against generating a Java String and
converting it to double. | | public XMLString | trim()
Removes white space from both ends of this string. |
| m_hash | | protected int m_hash(Code) | | cached hash code
|
| m_length | | int m_length(Code) | | The length of the string.
|
| m_start | | int m_start(Code) | | The start position in the fsb.
|
| m_strCache | | protected String m_strCache(Code) | | If the str() function is called, the string will be cached here.
|
| serialVersionUID | | final static long serialVersionUID(Code) | | |
| XStringForFSB | | public XStringForFSB(FastStringBuffer val, int start, int length)(Code) | | Construct a XNodeSet object.
Parameters:
val - FastStringBuffer object this will wrap, must be non-null.
Parameters:
start - The start position in the array.
Parameters:
length - The number of characters to read from the array. |
| charAt | | public char charAt(int index)(Code) | | Returns the character at the specified index. An index ranges
from 0 to length() - 1. The first character
of the sequence is at index 0, the next at index
1, and so on, as for array indexing.
Parameters:
index - the index of the character. the character at the specified index of this string.The first character is at index 0.
exception:
IndexOutOfBoundsException - if the indexargument is negative or not less than the length of thisstring. |
| compareTo | | public int compareTo(XMLString xstr)(Code) | | Compares two strings lexicographically.
Parameters:
xstr - the String to be compared. the value 0 if the argument string is equal tothis string; a value less than 0 if this stringis lexicographically less than the string argument; and avalue greater than 0 if this string islexicographically greater than the string argument.
exception:
java.lang.NullPointerException - if anotherStringis null. |
| compareToIgnoreCase | | public int compareToIgnoreCase(XMLString xstr)(Code) | | Compares two strings lexicographically, ignoring case considerations.
This method returns an integer whose sign is that of
this.toUpperCase().toLowerCase().compareTo(
str.toUpperCase().toLowerCase()).
Note that this method does not take locale into account,
and will result in an unsatisfactory ordering for certain locales.
The java.text package provides collators to allow
locale-sensitive ordering.
Parameters:
xstr - the String to be compared. a negative integer, zero, or a positive integer as thethe specified String is greater than, equal to, or lessthan this String, ignoring case considerations.
See Also: java.text.Collator.compare(StringString)
since:
1.2 |
| concat | | public XMLString concat(String str)(Code) | | Concatenates the specified string to the end of this string.
Parameters:
str - the String that is concatenated to the endof this String. a string that represents the concatenation of this object'scharacters followed by the string argument's characters.
exception:
java.lang.NullPointerException - if str isnull. |
| dispatchCharactersEvents | | public void dispatchCharactersEvents(org.xml.sax.ContentHandler ch) throws org.xml.sax.SAXException(Code) | | Directly call the
characters method on the passed ContentHandler for the
string-value. Multiple calls to the
ContentHandler's characters methods may well occur for a single call to
this method.
Parameters:
ch - A non-null reference to a ContentHandler.
throws:
org.xml.sax.SAXException - |
| equalsIgnoreCase | | public boolean equalsIgnoreCase(String anotherString)(Code) | | Compares this String to another String,
ignoring case considerations. Two strings are considered equal
ignoring case if they are of the same length, and corresponding
characters in the two strings are equal ignoring case.
Parameters:
anotherString - the String to compare thisString against. true if the argument is not nulland the Strings are equal,ignoring case; false otherwise.
See Also: XStringForFSB.equals(Object)
See Also: java.lang.Character.toLowerCase(char)
See Also: java.lang.Character.toUpperCase(char) |
| fixWhiteSpace | | public XMLString fixWhiteSpace(boolean trimHead, boolean trimTail, boolean doublePunctuationSpaces)(Code) | | Conditionally trim all leading and trailing whitespace in the specified String.
All strings of white space are
replaced by a single space character (#x20), except spaces after punctuation which
receive double spaces if doublePunctuationSpaces is true.
This function may be useful to a formatter, but to get first class
results, the formatter should probably do it's own white space handling
based on the semantics of the formatting object.
Parameters:
trimHead - Trim leading whitespace?
Parameters:
trimTail - Trim trailing whitespace?
Parameters:
doublePunctuationSpaces - Use double spaces for punctuation? The trimmed string. |
| fsb | | public FastStringBuffer fsb()(Code) | | Cast result object to a string.
The string this wraps or the empty string if null |
| getChars | | public void getChars(int srcBegin, int srcEnd, char dst, int dstBegin)(Code) | | Copies characters from this string into the destination character
array.
Parameters:
srcBegin - index of the first character in the stringto copy.
Parameters:
srcEnd - index after the last character in the stringto copy.
Parameters:
dst - the destination array.
Parameters:
dstBegin - the start offset in the destination array.
exception:
IndexOutOfBoundsException - If any of the followingis true:srcBegin is negative.srcBegin is greater than srcEndsrcEnd is greater than the length of thisstringdstBegin is negativedstBegin+(srcEnd-srcBegin) is larger thandst.length
exception:
NullPointerException - if dst is null |
| hasString | | public boolean hasString()(Code) | | Tell if this object contains a java String object.
true if this XMLString can return a string without creating one. |
| hashCode | | public int hashCode()(Code) | | Returns a hashcode for this string. The hashcode for a
String object is computed as
s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]
using int arithmetic, where s[i] is the
ith character of the string, n is the length of
the string, and ^ indicates exponentiation.
(The hash value of the empty string is zero.)
a hash code value for this object. |
| indexOf | | public int indexOf(int ch)(Code) | | Returns the index within this string of the first occurrence of the
specified character. If a character with value ch occurs
in the character sequence represented by this String
object, then the index of the first such occurrence is returned --
that is, the smallest value k such that:
this.charAt(k) == ch
is true. If no such character occurs in this string,
then -1 is returned.
Parameters:
ch - a character. the index of the first occurrence of the character in thecharacter sequence represented by this object, or-1 if the character does not occur. |
| indexOf | | public int indexOf(int ch, int fromIndex)(Code) | | Returns the index within this string of the first occurrence of the
specified character, starting the search at the specified index.
If a character with value ch occurs in the character
sequence represented by this String object at an index
no smaller than fromIndex, then the index of the first
such occurrence is returned--that is, the smallest value k
such that:
(this.charAt(k) == ch) && (k >= fromIndex)
is true. If no such character occurs in this string at or after
position fromIndex, then -1 is returned.
There is no restriction on the value of fromIndex. If it
is negative, it has the same effect as if it were zero: this entire
string may be searched. If it is greater than the length of this
string, it has the same effect as if it were equal to the length of
this string: -1 is returned.
Parameters:
ch - a character.
Parameters:
fromIndex - the index to start the search from. the index of the first occurrence of the character in thecharacter sequence represented by this object that is greaterthan or equal to fromIndex, or -1if the character does not occur. |
| length | | public int length()(Code) | | Returns the length of this string.
the length of the sequence of characters represented by thisobject. |
| object | | public Object object()(Code) | | Since this object is incomplete without the length and the offset, we
have to convert to a string when this function is called.
The java String representation of this object. |
| startsWith | | public boolean startsWith(XMLString prefix, int toffset)(Code) | | Tests if this string starts with the specified prefix beginning
a specified index.
Parameters:
prefix - the prefix.
Parameters:
toffset - where to begin looking in the string. true if the character sequence represented by theargument is a prefix of the substring of this object startingat index toffset; false otherwise.The result is false if toffset isnegative or greater than the length of thisString object; otherwise the result is the sameas the result of the expressionthis.subString(toffset).startsWith(prefix)
exception:
java.lang.NullPointerException - if prefix isnull. |
| startsWith | | public boolean startsWith(XMLString prefix)(Code) | | Tests if this string starts with the specified prefix.
Parameters:
prefix - the prefix. true if the character sequence represented by theargument is a prefix of the character sequence represented bythis string; false otherwise.Note also that true will be returned if theargument is an empty string or is equal to thisString object as determined by theXStringForFSB.equals(Object) method.
exception:
java.lang.NullPointerException - if prefix isnull.
since:
JDK1. 0 |
| str | | public String str()(Code) | | Cast result object to a string.
The string this wraps or the empty string if null |
| substring | | public XMLString substring(int beginIndex)(Code) | | Returns a new string that is a substring of this string. The
substring begins with the character at the specified index and
extends to the end of this string.
Examples:
"unhappy".substring(2) returns "happy"
"Harbison".substring(3) returns "bison"
"emptiness".substring(9) returns "" (an empty string)
Parameters:
beginIndex - the beginning index, inclusive. the specified substring.
exception:
IndexOutOfBoundsException - ifbeginIndex is negative or larger than thelength of this String object. |
| substring | | public XMLString substring(int beginIndex, int endIndex)(Code) | | Returns a new string that is a substring of this string. The
substring begins at the specified beginIndex and
extends to the character at index endIndex - 1.
Thus the length of the substring is endIndex-beginIndex.
Parameters:
beginIndex - the beginning index, inclusive.
Parameters:
endIndex - the ending index, exclusive. the specified substring.
exception:
IndexOutOfBoundsException - if thebeginIndex is negative, orendIndex is larger than the length ofthis String object, orbeginIndex is larger thanendIndex. |
| toDouble | | public double toDouble()(Code) | | Convert a string to a double -- Allowed input is in fixed
notation ddd.fff.
%OPT% CHECK PERFORMANCE against generating a Java String and
converting it to double. The advantage of running in native
machine code -- perhaps even microcode, on some systems -- may
more than make up for the cost of allocating and discarding the
additional object. We need to benchmark this.
%OPT% More importantly, we need to decide whether we _care_ about
the performance of this operation. Does XString.toDouble constitute
any measurable percentage of our typical runtime? I suspect not!
A double value representation of the string, or return Double.NaN if the string can not be converted. |
| trim | | public XMLString trim()(Code) | | Removes white space from both ends of this string.
this string, with white space removed from the front and end. |
| Methods inherited from org.apache.xpath.objects.XString | public boolean bool()(Code)(Java Doc)
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)(Code)(Java Doc)
public char charAt(int index)(Code)(Java Doc)
public int compareTo(XMLString xstr)(Code)(Java Doc)
public int compareToIgnoreCase(XMLString str)(Code)(Java Doc)
public XMLString concat(String str)(Code)(Java Doc)
public void dispatchAsComment(org.xml.sax.ext.LexicalHandler lh) throws org.xml.sax.SAXException(Code)(Java Doc)
public void dispatchCharactersEvents(org.xml.sax.ContentHandler ch) throws org.xml.sax.SAXException(Code)(Java Doc)
public boolean endsWith(String suffix)(Code)(Java Doc)
public boolean equals(XObject obj2)(Code)(Java Doc)
public boolean equals(XMLString obj2)(Code)(Java Doc)
public boolean equals(Object obj2)(Code)(Java Doc)
public boolean equalsIgnoreCase(String anotherString)(Code)(Java Doc)
public XMLString fixWhiteSpace(boolean trimHead, boolean trimTail, boolean doublePunctuationSpaces)(Code)(Java Doc)
public void getChars(int srcBegin, int srcEnd, char dst, int dstBegin)(Code)(Java Doc)
public int getType()(Code)(Java Doc)
public String getTypeString()(Code)(Java Doc)
public boolean hasString()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public int indexOf(int ch)(Code)(Java Doc)
public int indexOf(int ch, int fromIndex)(Code)(Java Doc)
public int indexOf(String str)(Code)(Java Doc)
public int indexOf(XMLString str)(Code)(Java Doc)
public int indexOf(String str, int fromIndex)(Code)(Java Doc)
public int lastIndexOf(int ch)(Code)(Java Doc)
public int lastIndexOf(int ch, int fromIndex)(Code)(Java Doc)
public int lastIndexOf(String str)(Code)(Java Doc)
public int lastIndexOf(String str, int fromIndex)(Code)(Java Doc)
public int length()(Code)(Java Doc)
public double num()(Code)(Java Doc)
public int rtf(XPathContext support)(Code)(Java Doc)
public boolean startsWith(String prefix, int toffset)(Code)(Java Doc)
public boolean startsWith(String prefix)(Code)(Java Doc)
public boolean startsWith(XMLString prefix, int toffset)(Code)(Java Doc)
public boolean startsWith(XMLString prefix)(Code)(Java Doc)
public String str()(Code)(Java Doc)
public XMLString substring(int beginIndex)(Code)(Java Doc)
public XMLString substring(int beginIndex, int endIndex)(Code)(Java Doc)
public double toDouble()(Code)(Java Doc)
public XMLString toLowerCase(Locale locale)(Code)(Java Doc)
public XMLString toLowerCase()(Code)(Java Doc)
public XMLString toUpperCase(Locale locale)(Code)(Java Doc)
public XMLString toUpperCase()(Code)(Java Doc)
public XMLString trim()(Code)(Java Doc)
public XMLString xstr()(Code)(Java Doc)
|
|
|