|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xpath.Expression | +--org.apache.xpath.objects.XObject | +--org.apache.xpath.objects.XString | +--org.apache.xpath.objects.XStringForFSB
This class will wrap a FastStringBuffer and allow for
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 | |
XStringForFSB(FastStringBuffer val,
int start,
int length)
Construct a XNodeSet object. |
Method Summary | |
void |
appendToFsb(FastStringBuffer fsb)
Cast result object to a string. |
char |
charAt(int index)
Returns the character at the specified index. |
int |
compareTo(XMLString xstr)
Compares two strings lexicographically. |
int |
compareToIgnoreCase(XMLString xstr)
Compares two strings lexicographically, ignoring case considerations. |
XMLString |
concat(java.lang.String str)
Concatenates the specified string to the end of this string. |
void |
dispatchAsComment(LexicalHandler lh)
Directly call the comment method on the passed LexicalHandler for the string-value. |
void |
dispatchCharactersEvents(ContentHandler ch)
Directly call the characters method on the passed ContentHandler for the string-value. |
boolean |
equals(java.lang.Object obj2)
Compares this string to the specified object. |
boolean |
equals(java.lang.String anotherString)
Tell if two objects are functionally equal. |
boolean |
equals(XMLString obj2)
Compares this string to the specified object. |
boolean |
equals(XObject obj2)
Tell if two objects are functionally equal. |
boolean |
equalsIgnoreCase(java.lang.String anotherString)
Compares this String to another String ,
ignoring case considerations. |
XMLString |
fixWhiteSpace(boolean trimHead,
boolean trimTail,
boolean doublePunctuationSpaces)
Conditionally trim all leading and trailing whitespace in the specified String. |
FastStringBuffer |
fsb()
Cast result object to a string. |
void |
getChars(int srcBegin,
int srcEnd,
char[] dst,
int dstBegin)
Copies characters from this string into the destination character array. |
int |
hashCode()
Returns a hashcode for this string. |
boolean |
hasString()
Tell if this object contains a java String object. |
int |
indexOf(int ch)
Returns the index within this string of the first occurrence of the specified character. |
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. |
int |
length()
Returns the length of this string. |
java.lang.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. |
boolean |
startsWith(XMLString prefix)
Tests if this string starts with the specified prefix. |
boolean |
startsWith(XMLString prefix,
int toffset)
Tests if this string starts with the specified prefix beginning a specified index. |
java.lang.String |
str()
Cast result object to a string. |
XMLString |
substring(int beginIndex)
Returns a new string that is a substring of this string. |
XMLString |
substring(int beginIndex,
int endIndex)
Returns a new string that is a substring of this string. |
double |
toDouble()
Convert a string to a double -- Allowed input is in fixed notation ddd.fff. |
XMLString |
trim()
Removes white space from both ends of this string. |
Methods inherited from class org.apache.xpath.objects.XString |
bool,
callVisitors,
endsWith,
getType,
getTypeString,
indexOf,
indexOf,
indexOf,
lastIndexOf,
lastIndexOf,
lastIndexOf,
lastIndexOf,
num,
rtf,
startsWith,
startsWith,
toLowerCase,
toLowerCase,
toUpperCase,
toUpperCase,
xstr |
Methods inherited from class org.apache.xpath.objects.XObject |
allowDetachToRelease,
boolWithSideEffects,
castToType,
create,
create,
deepEquals,
destruct,
detach,
execute,
fixupVariables,
getFresh,
greaterThan,
greaterThanOrEqual,
iter,
lessThan,
lessThanOrEqual,
mutableNodeset,
nodelist,
nodeset,
notEquals,
numWithSideEffects,
reset,
rtf,
rtree,
rtree,
toString |
Methods inherited from class org.apache.xpath.Expression |
asIterator,
asIteratorRaw,
asNode,
assertion,
bool,
canTraverseOutsideSubtree,
error,
execute,
execute,
execute,
executeCharsToContentHandler,
exprAddChild,
exprGetChild,
exprGetNumChildren,
exprGetParent,
exprSetParent,
getColumnNumber,
getExpressionOwner,
getLineNumber,
getPublicId,
getSystemId,
isNodesetExpr,
isStableNumber,
num,
warn,
xstr |
Methods inherited from class java.lang.Object |
getClass,
notify,
notifyAll,
wait,
wait,
wait |
Constructor Detail |
public XStringForFSB(FastStringBuffer val, int start, int length)
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.Method Detail |
public FastStringBuffer fsb()
public void appendToFsb(FastStringBuffer fsb)
public boolean hasString()
public java.lang.Object object()
public java.lang.String str()
public void dispatchCharactersEvents(ContentHandler ch) throws SAXException
ch
- A non-null reference to a ContentHandler.public void dispatchAsComment(LexicalHandler lh) throws SAXException
lh
- A non-null reference to a LexicalHandler.public int length()
public char charAt(int index)
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.index
- the index of the character.0
.index
argument is negative or not less than the length of this
string.public void getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin)
srcBegin
- index of the first character in the string
to copy.srcEnd
- index after the last character in the string
to copy.dst
- the destination array.dstBegin
- the start offset in the destination array.srcBegin
is negative.
srcBegin
is greater than srcEnd
srcEnd
is greater than the length of this
string
dstBegin
is negative
dstBegin+(srcEnd-srcBegin)
is larger than
dst.length
dst
is null
public boolean equals(XMLString obj2)
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.anObject
- the object to compare this String
against.
NEEDSDOC @param obj2true
if the String
are equal;
false
otherwise.String.compareTo(java.lang.String)
,
String.equalsIgnoreCase(java.lang.String)
public boolean equals(XObject obj2)
obj2
- Object to compare this topublic boolean equals(java.lang.String anotherString)
obj2
- Object to compare this to
NEEDSDOC @param anotherStringpublic boolean equals(java.lang.Object obj2)
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.anObject
- the object to compare this String
against.
NEEDSDOC @param obj2true
if the String
are equal;
false
otherwise.String.compareTo(java.lang.String)
,
String.equalsIgnoreCase(java.lang.String)
public boolean equalsIgnoreCase(java.lang.String anotherString)
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.anotherString
- the String
to compare this
String
against.true
if the argument is not null
and the String
s are equal,
ignoring case; false
otherwise.equals(Object)
,
Character.toLowerCase(char)
,
Character.toUpperCase(char)
public int compareTo(XMLString xstr)
anotherString
- the String
to be compared.
NEEDSDOC @param xstr0
if the argument string is equal to
this string; a value less than 0
if this string
is lexicographically less than the string argument; and a
value greater than 0
if this string is
lexicographically greater than the string argument.anotherString
is null
.public int compareToIgnoreCase(XMLString xstr)
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.
str
- the String
to be compared.
NEEDSDOC @param xstrCollator.compare(String, String)
public int hashCode()
String
object is computed as
usings[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]
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.)public boolean startsWith(XMLString prefix, int toffset)
prefix
- the prefix.toffset
- where to begin looking in the string.true
if the character sequence represented by the
argument is a prefix of the substring of this object starting
at index toffset
; false
otherwise.
The result is false
if toffset
is
negative or greater than the length of this
String
object; otherwise the result is the same
as the result of the expression
this.subString(toffset).startsWith(prefix)
prefix
is
null
.public boolean startsWith(XMLString prefix)
prefix
- the prefix.true
if the character sequence represented by the
argument is a prefix of the character sequence represented by
this string; false
otherwise.
Note also that true
will be returned if the
argument is an empty string or is equal to this
String
object as determined by the
equals(Object)
method.prefix
is
null
.public int indexOf(int ch)
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:
isthis.charAt(k) == ch
true
. If no such character occurs in this string,
then -1
is returned.ch
- a character.-1
if the character does not occur.public int indexOf(int ch, int fromIndex)
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:
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 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.
ch
- a character.fromIndex
- the index to start the search from.fromIndex
, or -1
if the character does not occur.public XMLString substring(int beginIndex)
Examples:
"unhappy".substring(2) returns "happy" "Harbison".substring(3) returns "bison" "emptiness".substring(9) returns "" (an empty string)
beginIndex
- the beginning index, inclusive.beginIndex
is negative or larger than the
length of this String
object.public XMLString substring(int beginIndex, int endIndex)
beginIndex
and
extends to the character at index endIndex - 1
.
Thus the length of the substring is endIndex-beginIndex
.beginIndex
- the beginning index, inclusive.endIndex
- the ending index, exclusive.beginIndex
is negative, or
endIndex
is larger than the length of
this String
object, or
beginIndex
is larger than
endIndex
.public XMLString concat(java.lang.String str)
str
- the String
that is concatenated to the end
of this String
.str
is
null
.public XMLString trim()
public XMLString fixWhiteSpace(boolean trimHead, boolean trimTail, boolean doublePunctuationSpaces)
trimHead
- Trim leading whitespace?trimTail
- Trim trailing whitespace?doublePunctuationSpaces
- Use double spaces for punctuation?public double toDouble()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |