Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.xpath.Expression
org.apache.xpath.objects.XObject
org.apache.xpath.objects.XString
org.apache.xpath.objects.XStringForFSB
public class XStringForFSB
extends XString
Field Summary |
Fields inherited from class org.apache.xpath.objects.XString | |
EMPTYSTRING |
Fields inherited from class org.apache.xpath.objects.XObject | |
CLASS_BOOLEAN , CLASS_NODESET , CLASS_NULL , CLASS_NUMBER , CLASS_RTREEFRAG , CLASS_STRING , CLASS_UNKNOWN , CLASS_UNRESOLVEDVARIABLE |
Constructor Summary | |
|
Method Summary | |
void |
|
char |
|
int | |
int |
|
XMLString |
|
void |
|
void |
|
boolean |
|
boolean |
|
boolean | |
boolean | |
boolean |
|
XMLString |
|
FastStringBuffer |
|
void |
|
boolean |
|
int |
|
int |
|
int |
|
int |
|
Object |
|
boolean |
|
boolean |
|
String |
|
XMLString |
|
XMLString |
|
double |
|
XMLString |
|
Methods inherited from class org.apache.xpath.objects.XString | |
bool , callVisitors , charAt , compareTo , compareToIgnoreCase , concat , dispatchAsComment , dispatchCharactersEvents , endsWith , equals , equals , equals , equals , equalsIgnoreCase , fixWhiteSpace , getChars , getType , getTypeString , hasString , hashCode , indexOf , indexOf , indexOf , indexOf , indexOf , lastIndexOf , lastIndexOf , lastIndexOf , lastIndexOf , length , num , rtf , startsWith , startsWith , startsWith , startsWith , str , substring , substring , toDouble , toLowerCase , toLowerCase , toUpperCase , toUpperCase , trim , xstr |
Methods inherited from class org.apache.xpath.objects.XObject | |
allowDetachToRelease , appendToFsb , bool , boolWithSideEffects , callVisitors , castToType , create , create , deepEquals , destruct , detach , dispatchCharactersEvents , equals , execute , fixupVariables , getFresh , getType , getTypeString , greaterThan , greaterThanOrEqual , iter , lessThan , lessThanOrEqual , mutableNodeset , nodelist , nodeset , notEquals , num , numWithSideEffects , object , reset , rtf , rtf , rtree , rtree , str , toString , xstr |
Methods inherited from class org.apache.xpath.Expression | |
asIterator , asIteratorRaw , asNode , assertion , bool , canTraverseOutsideSubtree , deepEquals , error , execute , execute , execute , execute , executeCharsToContentHandler , exprAddChild , exprGetChild , exprGetNumChildren , exprGetParent , exprSetParent , fixupVariables , getColumnNumber , getExpressionOwner , getLineNumber , getPublicId , getSystemId , isNodesetExpr , isStableNumber , num , warn , xstr |
public XStringForFSB(FastStringBuffer val, int start, int length)
Construct a XNodeSet object.
- Parameters:
val
- FastStringBuffer object this will wrap, must be non-null.start
- The start position in the array.length
- The number of characters to read from the array.
public void appendToFsb(FastStringBuffer fsb)
Cast result object to a string.
- Overrides:
- appendToFsb in interface XObject
public char charAt(int index)
Returns the character at the specified index. An index ranges from0
tolength() - 1
. The first character of the sequence is at index0
, the next at index1
, and so on, as for array indexing.
- Parameters:
index
- the index of the character.
- Returns:
- the character at the specified index of this string. The first character is at index
0
.
public int compareTo(XMLString xstr)
Compares two strings lexicographically.
- Parameters:
xstr
- theString
to be compared.
- Returns:
- the value
0
if the argument string is equal to this string; a value less than0
if this string is lexicographically less than the string argument; and a value greater than0
if this string is lexicographically greater than the string argument.
public int compareToIgnoreCase(XMLString xstr)
Compares two strings lexicographically, ignoring case considerations. This method returns an integer whose sign is that ofthis.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.
- Specified by:
- compareToIgnoreCase in interface XMLString
- Overrides:
- compareToIgnoreCase in interface XString
- Parameters:
xstr
- theString
to be compared.
- Returns:
- a negative integer, zero, or a positive integer as the the specified String is greater than, equal to, or less than this String, ignoring case considerations.
- Since:
- 1.2
- See Also:
java.text.Collator.compare(String, String)
public XMLString concat(String str)
Concatenates the specified string to the end of this string.
- Parameters:
str
- theString
that is concatenated to the end of thisString
.
- Returns:
- a string that represents the concatenation of this object's characters followed by the string argument's characters.
public void dispatchAsComment(org.xml.sax.ext.LexicalHandler lh) throws org.xml.sax.SAXException
Directly call the comment method on the passed LexicalHandler for the string-value.
- Specified by:
- dispatchAsComment in interface XMLString
- Overrides:
- dispatchAsComment in interface XString
- Parameters:
lh
- A non-null reference to a LexicalHandler.
public void dispatchCharactersEvents(org.xml.sax.ContentHandler ch) throws org.xml.sax.SAXException
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.
- Specified by:
- dispatchCharactersEvents in interface XMLString
- Overrides:
- dispatchCharactersEvents in interface XString
- Parameters:
ch
- A non-null reference to a ContentHandler.
public boolean equals(Object obj2)
Compares this string to the specified object. The result istrue
if and only if the argument is notnull
and is aString
object that represents the same sequence of characters as this object.
- Parameters:
obj2
- the object to compare thisString
against.
- Returns:
true
if theString
are equal;false
otherwise.
- See Also:
java.lang.String.compareTo(java.lang.String)
,java.lang.String.equalsIgnoreCase(java.lang.String)
public boolean equals(String anotherString)
Tell if two objects are functionally equal.
- Parameters:
anotherString
- Object to compare this to
- Returns:
- true if the two objects are equal
public boolean equals(XMLString obj2)
Compares this string to the specified object. The result istrue
if and only if the argument is notnull
and is aString
object that represents the same sequence of characters as this object.
- Parameters:
obj2
- the object to compare thisString
against.
- Returns:
true
if theString
are equal;false
otherwise.
- See Also:
java.lang.String.compareTo(java.lang.String)
,java.lang.String.equalsIgnoreCase(java.lang.String)
public boolean equals(XObject obj2)
Tell if two objects are functionally equal.
- Parameters:
obj2
- Object to compare this to
- Returns:
- true if the two objects are equal
public boolean equalsIgnoreCase(String anotherString)
Compares thisString
to anotherString
, 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.
- Specified by:
- equalsIgnoreCase in interface XMLString
- Overrides:
- equalsIgnoreCase in interface XString
- Parameters:
anotherString
- theString
to compare thisString
against.
- Returns:
true
if the argument is notnull
and theString
s are equal, ignoring case;false
otherwise.
- See Also:
equals(Object)
,java.lang.Character.toLowerCase(char)
,java.lang.Character.toUpperCase(char)
public XMLString fixWhiteSpace(boolean trimHead, boolean trimTail, boolean doublePunctuationSpaces)
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.
- Specified by:
- fixWhiteSpace in interface XMLString
- Overrides:
- fixWhiteSpace in interface XString
- Parameters:
trimHead
- Trim leading whitespace?trimTail
- Trim trailing whitespace?doublePunctuationSpaces
- Use double spaces for punctuation?
- Returns:
- The trimmed string.
public FastStringBuffer fsb()
Cast result object to a string.
- Returns:
- The string this wraps or the empty string if null
public void getChars(int srcBegin, int srcEnd, dst[] , int dstBegin)
Copies characters from this string into the destination character array.
- Parameters:
srcBegin
- index of the first character in the string to copy.srcEnd
- index after the last character in the string to copy.dstBegin
- the start offset in the destination array.
public boolean hasString()
Tell if this object contains a java String object.
- Returns:
- true if this XMLString can return a string without creating one.
public int hashCode()
Returns a hashcode for this string. The hashcode for aString
object is computed asusings[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]int
arithmetic, wheres[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.)
- Returns:
- a hash code value for this object.
public int indexOf(int ch)
Returns the index within this string of the first occurrence of the specified character. If a character with valuech
occurs in the character sequence represented by thisString
object, then the index of the first such occurrence is returned -- that is, the smallest value k such that:isthis.charAt(k) == chtrue
. If no such character occurs in this string, then-1
is returned.
- Parameters:
ch
- a character.
- Returns:
- the index of the first occurrence of the character in the character sequence represented by this object, or
-1
if the character does not occur.
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 valuech
occurs in the character sequence represented by thisString
object at an index no smaller thanfromIndex
, then the index of the first such occurrence is returned--that is, the smallest value k such that:is true. If no such character occurs in this string at or after position(this.charAt(k) == ch) && (k >= fromIndex)fromIndex
, then-1
is returned. There is no restriction on the value offromIndex
. 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.fromIndex
- the index to start the search from.
- Returns:
- the index of the first occurrence of the character in the character sequence represented by this object that is greater than or equal to
fromIndex
, or-1
if the character does not occur.
public int length()
Returns the length of this string.
- Returns:
- the length of the sequence of characters represented by this object.
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.
- Returns:
- The java String representation of this object.
public boolean startsWith(XMLString prefix)
Tests if this string starts with the specified prefix.
- Specified by:
- startsWith in interface XMLString
- Overrides:
- startsWith in interface XString
- Parameters:
prefix
- the prefix.
- Returns:
true
if the character sequence represented by the argument is a prefix of the character sequence represented by this string;false
otherwise. Note also thattrue
will be returned if the argument is an empty string or is equal to thisString
object as determined by theequals(Object)
method.
- Since:
- JDK1. 0
public boolean startsWith(XMLString prefix, int toffset)
Tests if this string starts with the specified prefix beginning a specified index.
- Specified by:
- startsWith in interface XMLString
- Overrides:
- startsWith in interface XString
- Parameters:
prefix
- the prefix.toffset
- where to begin looking in the string.
- Returns:
true
if the character sequence represented by the argument is a prefix of the substring of this object starting at indextoffset
;false
otherwise. The result isfalse
iftoffset
is negative or greater than the length of thisString
object; otherwise the result is the same as the result of the expressionthis.subString(toffset).startsWith(prefix)
public String str()
Cast result object to a string.
- Returns:
- The string this wraps or the empty string if null
public XMLString substring(int beginIndex)
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.
- Returns:
- the specified substring.
public XMLString substring(int beginIndex, int endIndex)
Returns a new string that is a substring of this string. The substring begins at the specifiedbeginIndex
and extends to the character at indexendIndex - 1
. Thus the length of the substring isendIndex-beginIndex
.
- Parameters:
beginIndex
- the beginning index, inclusive.endIndex
- the ending index, exclusive.
- Returns:
- the specified substring.
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. 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!
- Returns:
- A double value representation of the string, or return Double.NaN if the string can not be converted.