| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
|
| <!--NewPage-->
|
| <HTML>
|
| <HEAD>
|
| <!-- Generated by javadoc on Thu Nov 22 17:12:57 EST 2007 -->
|
| <TITLE>
|
| Xalan-Java 2.7.1: Class XMLStringDefault
|
| </TITLE>
|
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
|
| </HEAD>
|
| <BODY BGCOLOR="white">
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <TR ALIGN="center" VALIGN="top">
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XMLStringDefault.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
| </TR>
|
| </TABLE>
|
| </TD>
|
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
| </EM>
|
| </TD>
|
| </TR>
|
|
|
| <TR>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../org/apache/xml/utils/XMLReaderManager.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../org/apache/xml/utils/XMLStringFactory.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="XMLStringDefault.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| <!-- ======== START OF CLASS DATA ======== -->
|
| <H2>
|
| <FONT SIZE="-1">
|
| org.apache.xml.utils</FONT>
|
| <BR>
|
| Class XMLStringDefault</H2>
|
| <PRE>
|
| java.lang.Object
|
| |
|
| +--<B>org.apache.xml.utils.XMLStringDefault</B>
|
| </PRE>
|
| <HR>
|
| <DL>
|
| <DT>public class <B>XMLStringDefault</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A></DL>
|
|
|
| <P>
|
| The default implementation of the XMLString interface, |
| which is just a simple wrapper of a String object.
|
| <P>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== INNER CLASS SUMMARY ======== -->
|
|
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
| <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Constructor Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#XMLStringDefault(java.lang.String)">XMLStringDefault</A></B>(java.lang.String str)</CODE>
|
|
|
| <BR>
|
| Create a XMLStringDefault object from a String</TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <!-- ========== METHOD SUMMARY =========== -->
|
|
|
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Method Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> char</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#charAt(int)">charAt</A></B>(int index)</CODE>
|
|
|
| <BR>
|
| Returns the character at the specified index.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#compareTo(org.apache.xml.utils.XMLString)">compareTo</A></B>(<A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> anotherString)</CODE>
|
|
|
| <BR>
|
| Compares two strings lexicographically.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#compareToIgnoreCase(org.apache.xml.utils.XMLString)">compareToIgnoreCase</A></B>(<A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> str)</CODE>
|
|
|
| <BR>
|
| Compares two strings lexicographically, ignoring case considerations.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#concat(java.lang.String)">concat</A></B>(java.lang.String str)</CODE>
|
|
|
| <BR>
|
| Concatenates the specified string to the end of this string.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#dispatchAsComment(org.xml.sax.ext.LexicalHandler)">dispatchAsComment</A></B>(<A HREF="../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A> lh)</CODE>
|
|
|
| <BR>
|
| Directly call the |
| comment method on the passed LexicalHandler for the |
| string-value.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#dispatchCharactersEvents(org.xml.sax.ContentHandler)">dispatchCharactersEvents</A></B>(<A HREF="../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> ch)</CODE>
|
|
|
| <BR>
|
| Directly call the |
| characters method on the passed ContentHandler for the |
| string-value.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#endsWith(java.lang.String)">endsWith</A></B>(java.lang.String suffix)</CODE>
|
|
|
| <BR>
|
| Tests if this string ends with the specified suffix.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object anObject)</CODE>
|
|
|
| <BR>
|
| Compares this string to the specified object.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#equals(java.lang.String)">equals</A></B>(java.lang.String obj2)</CODE>
|
|
|
| <BR>
|
| Compares this string to the specified <code>String</code>.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#equals(org.apache.xml.utils.XMLString)">equals</A></B>(<A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> anObject)</CODE>
|
|
|
| <BR>
|
| Compares this string to the specified object.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#equalsIgnoreCase(java.lang.String)">equalsIgnoreCase</A></B>(java.lang.String anotherString)</CODE>
|
|
|
| <BR>
|
| Compares this <code>String</code> to another <code>String</code>, |
| ignoring case considerations.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#fixWhiteSpace(boolean, boolean, boolean)">fixWhiteSpace</A></B>(boolean trimHead, |
| boolean trimTail, |
| boolean doublePunctuationSpaces)</CODE>
|
|
|
| <BR>
|
| Conditionally trim all leading and trailing whitespace in the specified String.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#getChars(int, int, char[], int)">getChars</A></B>(int srcBegin, |
| int srcEnd, |
| char[] dst, |
| int dstBegin)</CODE>
|
|
|
| <BR>
|
| Copies characters from this string into the destination character |
| array.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#hashCode()">hashCode</A></B>()</CODE>
|
|
|
| <BR>
|
| Returns a hashcode for this string.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#hasString()">hasString</A></B>()</CODE>
|
|
|
| <BR>
|
| Tell if this object contains a java String object.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#indexOf(int)">indexOf</A></B>(int ch)</CODE>
|
|
|
| <BR>
|
| Returns the index within this string of the first occurrence of the |
| specified character.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#indexOf(int, int)">indexOf</A></B>(int ch, |
| int fromIndex)</CODE>
|
|
|
| <BR>
|
| Returns the index within this string of the first occurrence of the |
| specified character, starting the search at the specified index.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#indexOf(java.lang.String)">indexOf</A></B>(java.lang.String str)</CODE>
|
|
|
| <BR>
|
| Returns the index within this string of the first occurrence of the |
| specified substring.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#indexOf(java.lang.String, int)">indexOf</A></B>(java.lang.String str, |
| int fromIndex)</CODE>
|
|
|
| <BR>
|
| Returns the index within this string of the first occurrence of the |
| specified substring, starting at the specified index.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#indexOf(org.apache.xml.utils.XMLString)">indexOf</A></B>(<A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> str)</CODE>
|
|
|
| <BR>
|
| Returns the index within this string of the first occurrence of the |
| specified substring.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#lastIndexOf(int)">lastIndexOf</A></B>(int ch)</CODE>
|
|
|
| <BR>
|
| Returns the index within this string of the last occurrence of the |
| specified character.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#lastIndexOf(int, int)">lastIndexOf</A></B>(int ch, |
| int fromIndex)</CODE>
|
|
|
| <BR>
|
| Returns the index within this string of the last occurrence of the |
| specified character, searching backward starting at the specified |
| index.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#lastIndexOf(java.lang.String)">lastIndexOf</A></B>(java.lang.String str)</CODE>
|
|
|
| <BR>
|
| Returns the index within this string of the rightmost occurrence |
| of the specified substring.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#lastIndexOf(java.lang.String, int)">lastIndexOf</A></B>(java.lang.String str, |
| int fromIndex)</CODE>
|
|
|
| <BR>
|
| Returns the index within this string of the last occurrence of |
| the specified substring.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#length()">length</A></B>()</CODE>
|
|
|
| <BR>
|
| Returns the length of this string.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#startsWith(java.lang.String)">startsWith</A></B>(java.lang.String prefix)</CODE>
|
|
|
| <BR>
|
| Tests if this string starts with the specified prefix.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#startsWith(java.lang.String, int)">startsWith</A></B>(java.lang.String prefix, |
| int toffset)</CODE>
|
|
|
| <BR>
|
| Tests if this string starts with the specified prefix beginning |
| a specified index.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#startsWith(org.apache.xml.utils.XMLString)">startsWith</A></B>(<A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> prefix)</CODE>
|
|
|
| <BR>
|
| Tests if this string starts with the specified prefix.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#startsWith(org.apache.xml.utils.XMLString, int)">startsWith</A></B>(<A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> prefix, |
| int toffset)</CODE>
|
|
|
| <BR>
|
| Tests if this string starts with the specified prefix beginning |
| a specified index.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#substring(int)">substring</A></B>(int beginIndex)</CODE>
|
|
|
| <BR>
|
| Returns a new string that is a substring of this string.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#substring(int, int)">substring</A></B>(int beginIndex, |
| int endIndex)</CODE>
|
|
|
| <BR>
|
| Returns a new string that is a substring of this string.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> double</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#toDouble()">toDouble</A></B>()</CODE>
|
|
|
| <BR>
|
| Convert a string to a double -- Allowed input is in fixed |
| notation ddd.fff.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#toLowerCase()">toLowerCase</A></B>()</CODE>
|
|
|
| <BR>
|
| Converts all of the characters in this <code>String</code> to lower |
| case using the rules of the default locale, which is returned |
| by <code>Locale.getDefault</code>.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#toLowerCase(java.util.Locale)">toLowerCase</A></B>(java.util.Locale locale)</CODE>
|
|
|
| <BR>
|
| Converts all of the characters in this <code>String</code> to lower |
| case using the rules of the given <code>Locale</code>.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#toString()">toString</A></B>()</CODE>
|
|
|
| <BR>
|
| This object (which is already a string!) is itself returned.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#toUpperCase()">toUpperCase</A></B>()</CODE>
|
|
|
| <BR>
|
| Converts all of the characters in this <code>String</code> to upper |
| case using the rules of the default locale, which is returned |
| by <code>Locale.getDefault</code>.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#toUpperCase(java.util.Locale)">toUpperCase</A></B>(java.util.Locale locale)</CODE>
|
|
|
| <BR>
|
| Converts all of the characters in this <code>String</code> to upper |
| case using the rules of the given locale.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#trim()">trim</A></B>()</CODE>
|
|
|
| <BR>
|
| Removes white space from both ends of this string.</TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE>getClass,
|
| notify,
|
| notifyAll,
|
| wait,
|
| wait,
|
| wait</CODE></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <P>
|
|
|
| <!-- ============ FIELD DETAIL =========== -->
|
|
|
|
|
| <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Constructor Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="XMLStringDefault(java.lang.String)"><!-- --></A><H3>
|
| XMLStringDefault</H3>
|
| <PRE>
|
| public <B>XMLStringDefault</B>(java.lang.String str)</PRE>
|
| <DL>
|
| <DD>Create a XMLStringDefault object from a String</DL>
|
|
|
| <!-- ============ METHOD DETAIL ========== -->
|
|
|
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Method Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="dispatchCharactersEvents(org.xml.sax.ContentHandler)"><!-- --></A><H3>
|
| dispatchCharactersEvents</H3>
|
| <PRE>
|
| public void <B>dispatchCharactersEvents</B>(<A HREF="../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> ch) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#dispatchCharactersEvents(org.xml.sax.ContentHandler)">dispatchCharactersEvents</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>ch</CODE> - A non-null reference to a ContentHandler.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="dispatchAsComment(org.xml.sax.ext.LexicalHandler)"><!-- --></A><H3>
|
| dispatchAsComment</H3>
|
| <PRE>
|
| public void <B>dispatchAsComment</B>(<A HREF="../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A> lh) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Directly call the |
| comment method on the passed LexicalHandler for the |
| string-value.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#dispatchAsComment(org.xml.sax.ext.LexicalHandler)">dispatchAsComment</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>lh</CODE> - A non-null reference to a LexicalHandler.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="fixWhiteSpace(boolean, boolean, boolean)"><!-- --></A><H3>
|
| fixWhiteSpace</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> <B>fixWhiteSpace</B>(boolean trimHead, |
| boolean trimTail, |
| boolean doublePunctuationSpaces)</PRE>
|
| <DL>
|
| <DD>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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#fixWhiteSpace(boolean, boolean, boolean)">fixWhiteSpace</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>trimHead</CODE> - Trim leading whitespace?<DD><CODE>trimTail</CODE> - Trim trailing whitespace?<DD><CODE>doublePunctuationSpaces</CODE> - Use double spaces for punctuation?<DT><B>Returns:</B><DD>The trimmed string.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="length()"><!-- --></A><H3>
|
| length</H3>
|
| <PRE>
|
| public int <B>length</B>()</PRE>
|
| <DL>
|
| <DD>Returns the length of this string.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#length()">length</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Returns:</B><DD>the length of the sequence of characters represented by this |
| object.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="charAt(int)"><!-- --></A><H3>
|
| charAt</H3>
|
| <PRE>
|
| public char <B>charAt</B>(int index)</PRE>
|
| <DL>
|
| <DD>Returns the character at the specified index. An index ranges |
| from <code>0</code> to <code>length() - 1</code>. The first character |
| of the sequence is at index <code>0</code>, the next at index |
| <code>1</code>, and so on, as for array indexing.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#charAt(int)">charAt</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>index</CODE> - the index of the character.<DT><B>Returns:</B><DD>the character at the specified index of this string. |
| The first character is at index <code>0</code>.<DT><B>Throws:</B><DD>java.lang.IndexOutOfBoundsException - if the <code>index</code> |
| argument is negative or not less than the length of this |
| string.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getChars(int, int, char[], int)"><!-- --></A><H3>
|
| getChars</H3>
|
| <PRE>
|
| public void <B>getChars</B>(int srcBegin, |
| int srcEnd, |
| char[] dst, |
| int dstBegin)</PRE>
|
| <DL>
|
| <DD>Copies characters from this string into the destination character |
| array.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#getChars(int, int, char[], int)">getChars</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>srcBegin</CODE> - index of the first character in the string |
| to copy.<DD><CODE>srcEnd</CODE> - index after the last character in the string |
| to copy.<DD><CODE>dst</CODE> - the destination array.<DD><CODE>dstBegin</CODE> - the start offset in the destination array.<DT><B>Throws:</B><DD>java.lang.IndexOutOfBoundsException - If any of the following |
| is true: |
| <ul><li><code>srcBegin</code> is negative. |
| <li><code>srcBegin</code> is greater than <code>srcEnd</code> |
| <li><code>srcEnd</code> is greater than the length of this |
| string |
| <li><code>dstBegin</code> is negative |
| <li><code>dstBegin+(srcEnd-srcBegin)</code> is larger than |
| <code>dst.length</code></ul><DD>java.lang.NullPointerException - if <code>dst</code> is <code>null</code></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="equals(java.lang.String)"><!-- --></A><H3>
|
| equals</H3>
|
| <PRE>
|
| public boolean <B>equals</B>(java.lang.String obj2)</PRE>
|
| <DL>
|
| <DD>Compares this string to the specified <code>String</code>. |
| The result is <code>true</code> if and only if the argument is not |
| <code>null</code> and is a <code>String</code> object that represents |
| the same sequence of characters as this object.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#equals(java.lang.String)">equals</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>obj2</CODE> - the object to compare this <code>String</code> against.<DT><B>Returns:</B><DD><code>true</code> if the <code>String</code>s are equal; |
| <code>false</code> otherwise.<DT><B>See Also: </B><DD><CODE>String.compareTo(java.lang.String)</CODE>,
|
| <CODE>String.equalsIgnoreCase(java.lang.String)</CODE></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="equals(org.apache.xml.utils.XMLString)"><!-- --></A><H3>
|
| equals</H3>
|
| <PRE>
|
| public boolean <B>equals</B>(<A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> anObject)</PRE>
|
| <DL>
|
| <DD>Compares this string to the specified object. |
| The result is <code>true</code> if and only if the argument is not |
| <code>null</code> and is a <code>String</code> object that represents |
| the same sequence of characters as this object.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#equals(org.apache.xml.utils.XMLString)">equals</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>anObject</CODE> - the object to compare this <code>String</code> |
| against.<DT><B>Returns:</B><DD><code>true</code> if the <code>String </code>are equal; |
| <code>false</code> otherwise.<DT><B>See Also: </B><DD><CODE>String.compareTo(java.lang.String)</CODE>,
|
| <CODE>String.equalsIgnoreCase(java.lang.String)</CODE></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
|
| equals</H3>
|
| <PRE>
|
| public boolean <B>equals</B>(java.lang.Object anObject)</PRE>
|
| <DL>
|
| <DD>Compares this string to the specified object. |
| The result is <code>true</code> if and only if the argument is not |
| <code>null</code> and is a <code>String</code> object that represents |
| the same sequence of characters as this object.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#equals(java.lang.Object)">equals</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>anObject</CODE> - the object to compare this <code>String</code> |
| against.<DT><B>Returns:</B><DD><code>true</code> if the <code>String </code>are equal; |
| <code>false</code> otherwise.<DT><B>Overrides:</B><DD>equals in class java.lang.Object<DT><B>See Also: </B><DD><CODE>String.compareTo(java.lang.String)</CODE>,
|
| <CODE>String.equalsIgnoreCase(java.lang.String)</CODE></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="equalsIgnoreCase(java.lang.String)"><!-- --></A><H3>
|
| equalsIgnoreCase</H3>
|
| <PRE>
|
| public boolean <B>equalsIgnoreCase</B>(java.lang.String anotherString)</PRE>
|
| <DL>
|
| <DD>Compares this <code>String</code> to another <code>String</code>, |
| 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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#equalsIgnoreCase(java.lang.String)">equalsIgnoreCase</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>anotherString</CODE> - the <code>String</code> to compare this |
| <code>String</code> against.<DT><B>Returns:</B><DD><code>true</code> if the argument is not <code>null</code> |
| and the <code>String</code>s are equal, |
| ignoring case; <code>false</code> otherwise.<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#equals(java.lang.Object)"><CODE>equals(Object)</CODE></A>,
|
| <CODE>Character.toLowerCase(char)</CODE>,
|
| <CODE>Character.toUpperCase(char)</CODE></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="compareTo(org.apache.xml.utils.XMLString)"><!-- --></A><H3>
|
| compareTo</H3>
|
| <PRE>
|
| public int <B>compareTo</B>(<A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> anotherString)</PRE>
|
| <DL>
|
| <DD>Compares two strings lexicographically.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#compareTo(org.apache.xml.utils.XMLString)">compareTo</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>anotherString</CODE> - the <code>String</code> to be compared.<DT><B>Returns:</B><DD>the value <code>0</code> if the argument string is equal to |
| this string; a value less than <code>0</code> if this string |
| is lexicographically less than the string argument; and a |
| value greater than <code>0</code> if this string is |
| lexicographically greater than the string argument.<DT><B>Throws:</B><DD>java.lang.NullPointerException - if <code>anotherString</code> |
| is <code>null</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="compareToIgnoreCase(org.apache.xml.utils.XMLString)"><!-- --></A><H3>
|
| compareToIgnoreCase</H3>
|
| <PRE>
|
| public int <B>compareToIgnoreCase</B>(<A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> str)</PRE>
|
| <DL>
|
| <DD>Compares two strings lexicographically, ignoring case considerations. |
| This method returns an integer whose sign is that of |
| <code>this.toUpperCase().toLowerCase().compareTo( |
| str.toUpperCase().toLowerCase())</code>. |
| <p> |
| Note that this method does <em>not</em> take locale into account, |
| and will result in an unsatisfactory ordering for certain locales. |
| The java.text package provides <em>collators</em> to allow |
| locale-sensitive ordering.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#compareToIgnoreCase(org.apache.xml.utils.XMLString)">compareToIgnoreCase</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>str</CODE> - the <code>String</code> to be compared.<DT><B>Returns:</B><DD>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.<DT><B>Since: </B><DD>1.2</DD>
|
| <DT><B>See Also: </B><DD><CODE>Collator.compare(String, String)</CODE></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startsWith(java.lang.String, int)"><!-- --></A><H3>
|
| startsWith</H3>
|
| <PRE>
|
| public boolean <B>startsWith</B>(java.lang.String prefix, |
| int toffset)</PRE>
|
| <DL>
|
| <DD>Tests if this string starts with the specified prefix beginning |
| a specified index.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#startsWith(java.lang.String, int)">startsWith</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>prefix</CODE> - the prefix.<DD><CODE>toffset</CODE> - where to begin looking in the string.<DT><B>Returns:</B><DD><code>true</code> if the character sequence represented by the |
| argument is a prefix of the substring of this object starting |
| at index <code>toffset</code>; <code>false</code> otherwise. |
| The result is <code>false</code> if <code>toffset</code> is |
| negative or greater than the length of this |
| <code>String</code> object; otherwise the result is the same |
| as the result of the expression |
| <pre> |
| this.subString(toffset).startsWith(prefix) |
| </pre><DT><B>Throws:</B><DD>java.lang.NullPointerException - if <code>prefix</code> is |
| <code>null</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startsWith(org.apache.xml.utils.XMLString, int)"><!-- --></A><H3>
|
| startsWith</H3>
|
| <PRE>
|
| public boolean <B>startsWith</B>(<A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> prefix, |
| int toffset)</PRE>
|
| <DL>
|
| <DD>Tests if this string starts with the specified prefix beginning |
| a specified index.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#startsWith(org.apache.xml.utils.XMLString, int)">startsWith</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>prefix</CODE> - the prefix.<DD><CODE>toffset</CODE> - where to begin looking in the string.<DT><B>Returns:</B><DD><code>true</code> if the character sequence represented by the |
| argument is a prefix of the substring of this object starting |
| at index <code>toffset</code>; <code>false</code> otherwise. |
| The result is <code>false</code> if <code>toffset</code> is |
| negative or greater than the length of this |
| <code>String</code> object; otherwise the result is the same |
| as the result of the expression |
| <pre> |
| this.subString(toffset).startsWith(prefix) |
| </pre><DT><B>Throws:</B><DD>java.lang.NullPointerException - if <code>prefix</code> is |
| <code>null</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startsWith(java.lang.String)"><!-- --></A><H3>
|
| startsWith</H3>
|
| <PRE>
|
| public boolean <B>startsWith</B>(java.lang.String prefix)</PRE>
|
| <DL>
|
| <DD>Tests if this string starts with the specified prefix.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#startsWith(java.lang.String)">startsWith</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>prefix</CODE> - the prefix.<DT><B>Returns:</B><DD><code>true</code> if the character sequence represented by the |
| argument is a prefix of the character sequence represented by |
| this string; <code>false</code> otherwise. |
| Note also that <code>true</code> will be returned if the |
| argument is an empty string or is equal to this |
| <code>String</code> object as determined by the |
| <A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#equals(java.lang.Object)"><CODE>equals(Object)</CODE></A> method.<DT><B>Throws:</B><DD>java.lang.NullPointerException - if <code>prefix</code> is |
| <code>null</code>.<DT><B>Since: </B><DD>JDK1. 0</DD>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startsWith(org.apache.xml.utils.XMLString)"><!-- --></A><H3>
|
| startsWith</H3>
|
| <PRE>
|
| public boolean <B>startsWith</B>(<A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> prefix)</PRE>
|
| <DL>
|
| <DD>Tests if this string starts with the specified prefix.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#startsWith(org.apache.xml.utils.XMLString)">startsWith</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>prefix</CODE> - the prefix.<DT><B>Returns:</B><DD><code>true</code> if the character sequence represented by the |
| argument is a prefix of the character sequence represented by |
| this string; <code>false</code> otherwise. |
| Note also that <code>true</code> will be returned if the |
| argument is an empty string or is equal to this |
| <code>String</code> object as determined by the |
| <A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#equals(java.lang.Object)"><CODE>equals(Object)</CODE></A> method.<DT><B>Throws:</B><DD>java.lang.NullPointerException - if <code>prefix</code> is |
| <code>null</code>.<DT><B>Since: </B><DD>JDK1. 0</DD>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endsWith(java.lang.String)"><!-- --></A><H3>
|
| endsWith</H3>
|
| <PRE>
|
| public boolean <B>endsWith</B>(java.lang.String suffix)</PRE>
|
| <DL>
|
| <DD>Tests if this string ends with the specified suffix.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#endsWith(java.lang.String)">endsWith</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>suffix</CODE> - the suffix.<DT><B>Returns:</B><DD><code>true</code> if the character sequence represented by the |
| argument is a suffix of the character sequence represented by |
| this object; <code>false</code> otherwise. Note that the |
| result will be <code>true</code> if the argument is the |
| empty string or is equal to this <code>String</code> object |
| as determined by the <A HREF="../../../../org/apache/xml/utils/XMLStringDefault.html#equals(java.lang.Object)"><CODE>equals(Object)</CODE></A> method.<DT><B>Throws:</B><DD>java.lang.NullPointerException - if <code>suffix</code> is |
| <code>null</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="hashCode()"><!-- --></A><H3>
|
| hashCode</H3>
|
| <PRE>
|
| public int <B>hashCode</B>()</PRE>
|
| <DL>
|
| <DD>Returns a hashcode for this string. The hashcode for a |
| <code>String</code> object is computed as |
| <blockquote><pre> |
| s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1] |
| </pre></blockquote> |
| using <code>int</code> arithmetic, where <code>s[i]</code> is the |
| <i>i</i>th character of the string, <code>n</code> is the length of |
| the string, and <code>^</code> indicates exponentiation. |
| (The hash value of the empty string is zero.)<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#hashCode()">hashCode</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Returns:</B><DD>a hash code value for this object.<DT><B>Overrides:</B><DD>hashCode in class java.lang.Object</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="indexOf(int)"><!-- --></A><H3>
|
| indexOf</H3>
|
| <PRE>
|
| public int <B>indexOf</B>(int ch)</PRE>
|
| <DL>
|
| <DD>Returns the index within this string of the first occurrence of the |
| specified character. If a character with value <code>ch</code> occurs |
| in the character sequence represented by this <code>String</code> |
| object, then the index of the first such occurrence is returned -- |
| that is, the smallest value <i>k</i> such that: |
| <blockquote><pre> |
| this.charAt(<i>k</i>) == ch |
| </pre></blockquote> |
| is <code>true</code>. If no such character occurs in this string, |
| then <code>-1</code> is returned.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#indexOf(int)">indexOf</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>ch</CODE> - a character.<DT><B>Returns:</B><DD>the index of the first occurrence of the character in the |
| character sequence represented by this object, or |
| <code>-1</code> if the character does not occur.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="indexOf(int, int)"><!-- --></A><H3>
|
| indexOf</H3>
|
| <PRE>
|
| public int <B>indexOf</B>(int ch, |
| int fromIndex)</PRE>
|
| <DL>
|
| <DD>Returns the index within this string of the first occurrence of the |
| specified character, starting the search at the specified index. |
| <p> |
| If a character with value <code>ch</code> occurs in the character |
| sequence represented by this <code>String</code> object at an index |
| no smaller than <code>fromIndex</code>, then the index of the first |
| such occurrence is returned--that is, the smallest value <i>k</i> |
| such that: |
| <blockquote><pre> |
| (this.charAt(<i>k</i>) == ch) && (<i>k</i> >= fromIndex) |
| </pre></blockquote> |
| is true. If no such character occurs in this string at or after |
| position <code>fromIndex</code>, then <code>-1</code> is returned. |
| <p> |
| There is no restriction on the value of <code>fromIndex</code>. 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: <code>-1</code> is returned.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#indexOf(int, int)">indexOf</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>ch</CODE> - a character.<DD><CODE>fromIndex</CODE> - the index to start the search from.<DT><B>Returns:</B><DD>the index of the first occurrence of the character in the |
| character sequence represented by this object that is greater |
| than or equal to <code>fromIndex</code>, or <code>-1</code> |
| if the character does not occur.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="lastIndexOf(int)"><!-- --></A><H3>
|
| lastIndexOf</H3>
|
| <PRE>
|
| public int <B>lastIndexOf</B>(int ch)</PRE>
|
| <DL>
|
| <DD>Returns the index within this string of the last occurrence of the |
| specified character. That is, the index returned is the largest |
| value <i>k</i> such that: |
| <blockquote><pre> |
| this.charAt(<i>k</i>) == ch |
| </pre></blockquote> |
| is true. |
| The String is searched backwards starting at the last character.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#lastIndexOf(int)">lastIndexOf</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>ch</CODE> - a character.<DT><B>Returns:</B><DD>the index of the last occurrence of the character in the |
| character sequence represented by this object, or |
| <code>-1</code> if the character does not occur.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="lastIndexOf(int, int)"><!-- --></A><H3>
|
| lastIndexOf</H3>
|
| <PRE>
|
| public int <B>lastIndexOf</B>(int ch, |
| int fromIndex)</PRE>
|
| <DL>
|
| <DD>Returns the index within this string of the last occurrence of the |
| specified character, searching backward starting at the specified |
| index. That is, the index returned is the largest value <i>k</i> |
| such that: |
| <blockquote><pre> |
| this.charAt(k) == ch) && (k <= fromIndex) |
| </pre></blockquote> |
| is true.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#lastIndexOf(int, int)">lastIndexOf</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>ch</CODE> - a character.<DD><CODE>fromIndex</CODE> - the index to start the search from. There is no |
| restriction on the value of <code>fromIndex</code>. If it is |
| greater than or equal to the length of this string, it has |
| the same effect as if it were equal to one less than the |
| length of this string: this entire string may be searched. |
| If it is negative, it has the same effect as if it were -1: |
| -1 is returned.<DT><B>Returns:</B><DD>the index of the last occurrence of the character in the |
| character sequence represented by this object that is less |
| than or equal to <code>fromIndex</code>, or <code>-1</code> |
| if the character does not occur before that point.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="indexOf(java.lang.String)"><!-- --></A><H3>
|
| indexOf</H3>
|
| <PRE>
|
| public int <B>indexOf</B>(java.lang.String str)</PRE>
|
| <DL>
|
| <DD>Returns the index within this string of the first occurrence of the |
| specified substring. The integer returned is the smallest value |
| <i>k</i> such that: |
| <blockquote><pre> |
| this.startsWith(str, <i>k</i>) |
| </pre></blockquote> |
| is <code>true</code>.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#indexOf(java.lang.String)">indexOf</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>str</CODE> - any string.<DT><B>Returns:</B><DD>if the string argument occurs as a substring within this |
| object, then the index of the first character of the first |
| such substring is returned; if it does not occur as a |
| substring, <code>-1</code> is returned.<DT><B>Throws:</B><DD>java.lang.NullPointerException - if <code>str</code> is |
| <code>null</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="indexOf(org.apache.xml.utils.XMLString)"><!-- --></A><H3>
|
| indexOf</H3>
|
| <PRE>
|
| public int <B>indexOf</B>(<A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> str)</PRE>
|
| <DL>
|
| <DD>Returns the index within this string of the first occurrence of the |
| specified substring. The integer returned is the smallest value |
| <i>k</i> such that: |
| <blockquote><pre> |
| this.startsWith(str, <i>k</i>) |
| </pre></blockquote> |
| is <code>true</code>.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#indexOf(org.apache.xml.utils.XMLString)">indexOf</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>str</CODE> - any string.<DT><B>Returns:</B><DD>if the string argument occurs as a substring within this |
| object, then the index of the first character of the first |
| such substring is returned; if it does not occur as a |
| substring, <code>-1</code> is returned.<DT><B>Throws:</B><DD>java.lang.NullPointerException - if <code>str</code> is |
| <code>null</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="indexOf(java.lang.String, int)"><!-- --></A><H3>
|
| indexOf</H3>
|
| <PRE>
|
| public int <B>indexOf</B>(java.lang.String str, |
| int fromIndex)</PRE>
|
| <DL>
|
| <DD>Returns the index within this string of the first occurrence of the |
| specified substring, starting at the specified index. The integer |
| returned is the smallest value <i>k</i> such that: |
| <blockquote><pre> |
| this.startsWith(str, <i>k</i>) && (<i>k</i> >= fromIndex) |
| </pre></blockquote> |
| is <code>true</code>. |
| <p> |
| There is no restriction on the value of <code>fromIndex</code>. 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: <code>-1</code> is returned.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#indexOf(java.lang.String, int)">indexOf</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>str</CODE> - the substring to search for.<DD><CODE>fromIndex</CODE> - the index to start the search from.<DT><B>Returns:</B><DD>If the string argument occurs as a substring within this |
| object at a starting index no smaller than |
| <code>fromIndex</code>, then the index of the first character |
| of the first such substring is returned. If it does not occur |
| as a substring starting at <code>fromIndex</code> or beyond, |
| <code>-1</code> is returned.<DT><B>Throws:</B><DD>java.lang.NullPointerException - if <code>str</code> is |
| <code>null</code></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="lastIndexOf(java.lang.String)"><!-- --></A><H3>
|
| lastIndexOf</H3>
|
| <PRE>
|
| public int <B>lastIndexOf</B>(java.lang.String str)</PRE>
|
| <DL>
|
| <DD>Returns the index within this string of the rightmost occurrence |
| of the specified substring. The rightmost empty string "" is |
| considered to occur at the index value <code>this.length()</code>. |
| The returned index is the largest value <i>k</i> such that |
| <blockquote><pre> |
| this.startsWith(str, k) |
| </pre></blockquote> |
| is true.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#lastIndexOf(java.lang.String)">lastIndexOf</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>str</CODE> - the substring to search for.<DT><B>Returns:</B><DD>if the string argument occurs one or more times as a substring |
| within this object, then the index of the first character of |
| the last such substring is returned. If it does not occur as |
| a substring, <code>-1</code> is returned.<DT><B>Throws:</B><DD>java.lang.NullPointerException - if <code>str</code> is |
| <code>null</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="lastIndexOf(java.lang.String, int)"><!-- --></A><H3>
|
| lastIndexOf</H3>
|
| <PRE>
|
| public int <B>lastIndexOf</B>(java.lang.String str, |
| int fromIndex)</PRE>
|
| <DL>
|
| <DD>Returns the index within this string of the last occurrence of |
| the specified substring.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#lastIndexOf(java.lang.String, int)">lastIndexOf</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>str</CODE> - the substring to search for.<DD><CODE>fromIndex</CODE> - the index to start the search from. There is no |
| restriction on the value of fromIndex. 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: this entire string |
| may be searched. If it is negative, it has the same effect |
| as if it were -1: -1 is returned.<DT><B>Returns:</B><DD>If the string argument occurs one or more times as a substring |
| within this object at a starting index no greater than |
| <code>fromIndex</code>, then the index of the first character of |
| the last such substring is returned. If it does not occur as a |
| substring starting at <code>fromIndex</code> or earlier, |
| <code>-1</code> is returned.<DT><B>Throws:</B><DD>java.lang.NullPointerException - if <code>str</code> is |
| <code>null</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="substring(int)"><!-- --></A><H3>
|
| substring</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> <B>substring</B>(int beginIndex)</PRE>
|
| <DL>
|
| <DD>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. <p> |
| Examples: |
| <blockquote><pre> |
| "unhappy".substring(2) returns "happy" |
| "Harbison".substring(3) returns "bison" |
| "emptiness".substring(9) returns "" (an empty string) |
| </pre></blockquote><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#substring(int)">substring</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>beginIndex</CODE> - the beginning index, inclusive.<DT><B>Returns:</B><DD>the specified substring.<DT><B>Throws:</B><DD>java.lang.IndexOutOfBoundsException - if |
| <code>beginIndex</code> is negative or larger than the |
| length of this <code>String</code> object.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="substring(int, int)"><!-- --></A><H3>
|
| substring</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> <B>substring</B>(int beginIndex, |
| int endIndex)</PRE>
|
| <DL>
|
| <DD>Returns a new string that is a substring of this string. The |
| substring begins at the specified <code>beginIndex</code> and |
| extends to the character at index <code>endIndex - 1</code>. |
| Thus the length of the substring is <code>endIndex-beginIndex</code>.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#substring(int, int)">substring</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>beginIndex</CODE> - the beginning index, inclusive.<DD><CODE>endIndex</CODE> - the ending index, exclusive.<DT><B>Returns:</B><DD>the specified substring.<DT><B>Throws:</B><DD>java.lang.IndexOutOfBoundsException - if the |
| <code>beginIndex</code> is negative, or |
| <code>endIndex</code> is larger than the length of |
| this <code>String</code> object, or |
| <code>beginIndex</code> is larger than |
| <code>endIndex</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="concat(java.lang.String)"><!-- --></A><H3>
|
| concat</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> <B>concat</B>(java.lang.String str)</PRE>
|
| <DL>
|
| <DD>Concatenates the specified string to the end of this string.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#concat(java.lang.String)">concat</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>str</CODE> - the <code>String</code> that is concatenated to the end |
| of this <code>String</code>.<DT><B>Returns:</B><DD>a string that represents the concatenation of this object's |
| characters followed by the string argument's characters.<DT><B>Throws:</B><DD>java.lang.NullPointerException - if <code>str</code> is |
| <code>null</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="toLowerCase(java.util.Locale)"><!-- --></A><H3>
|
| toLowerCase</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> <B>toLowerCase</B>(java.util.Locale locale)</PRE>
|
| <DL>
|
| <DD>Converts all of the characters in this <code>String</code> to lower |
| case using the rules of the given <code>Locale</code>.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#toLowerCase(java.util.Locale)">toLowerCase</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>locale</CODE> - use the case transformation rules for this locale<DT><B>Returns:</B><DD>the String, converted to lowercase.<DT><B>See Also: </B><DD><CODE>Character.toLowerCase(char)</CODE>,
|
| <CODE>String.toUpperCase(Locale)</CODE></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="toLowerCase()"><!-- --></A><H3>
|
| toLowerCase</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> <B>toLowerCase</B>()</PRE>
|
| <DL>
|
| <DD>Converts all of the characters in this <code>String</code> to lower |
| case using the rules of the default locale, which is returned |
| by <code>Locale.getDefault</code>. |
| <p><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#toLowerCase()">toLowerCase</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Returns:</B><DD>the string, converted to lowercase.<DT><B>See Also: </B><DD><CODE>Character.toLowerCase(char)</CODE>,
|
| <CODE>String.toLowerCase(Locale)</CODE></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="toUpperCase(java.util.Locale)"><!-- --></A><H3>
|
| toUpperCase</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> <B>toUpperCase</B>(java.util.Locale locale)</PRE>
|
| <DL>
|
| <DD>Converts all of the characters in this <code>String</code> to upper |
| case using the rules of the given locale.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#toUpperCase(java.util.Locale)">toUpperCase</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Parameters:</B><DD><CODE>locale</CODE> - use the case transformation rules for this locale<DT><B>Returns:</B><DD>the String, converted to uppercase.<DT><B>See Also: </B><DD><CODE>Character.toUpperCase(char)</CODE>,
|
| <CODE>String.toLowerCase(Locale)</CODE></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="toUpperCase()"><!-- --></A><H3>
|
| toUpperCase</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> <B>toUpperCase</B>()</PRE>
|
| <DL>
|
| <DD>Converts all of the characters in this <code>String</code> to upper |
| case using the rules of the default locale, which is returned |
| by <code>Locale.getDefault</code>. |
| |
| <p> |
| If no character in this string has a different uppercase version, |
| based on calling the <code>toUpperCase</code> method defined by |
| <code>Character</code>, then the original string is returned. |
| <p> |
| Otherwise, this method creates a new <code>String</code> object |
| representing a character sequence identical in length to the |
| character sequence represented by this <code>String</code> object and |
| with every character equal to the result of applying the method |
| <code>Character.toUpperCase</code> to the corresponding character of |
| this <code>String</code> object. <p> |
| Examples: |
| <blockquote><pre> |
| "Fahrvergnügen".toUpperCase() returns "FAHRVERGNÜGEN" |
| "Visit Ljubinje!".toUpperCase() returns "VISIT LJUBINJE!" |
| </pre></blockquote><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#toUpperCase()">toUpperCase</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Returns:</B><DD>the string, converted to uppercase.<DT><B>See Also: </B><DD><CODE>Character.toUpperCase(char)</CODE>,
|
| <CODE>String.toUpperCase(Locale)</CODE></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="trim()"><!-- --></A><H3>
|
| trim</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A> <B>trim</B>()</PRE>
|
| <DL>
|
| <DD>Removes white space from both ends of this string. |
| <p> |
| If this <code>String</code> object represents an empty character |
| sequence, or the first and last characters of character sequence |
| represented by this <code>String</code> object both have codes |
| greater than <code>'\u0020'</code> (the space character), then a |
| reference to this <code>String</code> object is returned. |
| <p> |
| Otherwise, if there is no character with a code greater than |
| <code>'\u0020'</code> in the string, then a new |
| <code>String</code> object representing an empty string is created |
| and returned. |
| <p> |
| Otherwise, let <i>k</i> be the index of the first character in the |
| string whose code is greater than <code>'\u0020'</code>, and let |
| <i>m</i> be the index of the last character in the string whose code |
| is greater than <code>'\u0020'</code>. A new <code>String</code> |
| object is created, representing the substring of this string that |
| begins with the character at index <i>k</i> and ends with the |
| character at index <i>m</i>-that is, the result of |
| <code>this.substring(<i>k</i>, <i>m</i>+1)</code>. |
| <p> |
| This method may be used to trim |
| whitespace from the beginning and end |
| of a string; in fact, it trims all ASCII control characters as well.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#trim()">trim</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Returns:</B><DD>this string, with white space removed from the front and end.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="toString()"><!-- --></A><H3>
|
| toString</H3>
|
| <PRE>
|
| public java.lang.String <B>toString</B>()</PRE>
|
| <DL>
|
| <DD>This object (which is already a string!) is itself returned.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#toString()">toString</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Returns:</B><DD>the string itself.<DT><B>Overrides:</B><DD>toString in class java.lang.Object</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="hasString()"><!-- --></A><H3>
|
| hasString</H3>
|
| <PRE>
|
| public boolean <B>hasString</B>()</PRE>
|
| <DL>
|
| <DD>Tell if this object contains a java String object.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#hasString()">hasString</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Returns:</B><DD>true if this XMLString can return a string without creating one.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="toDouble()"><!-- --></A><H3>
|
| toDouble</H3>
|
| <PRE>
|
| public double <B>toDouble</B>()</PRE>
|
| <DL>
|
| <DD>Convert a string to a double -- Allowed input is in fixed |
| notation ddd.fff.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/utils/XMLString.html#toDouble()">toDouble</A> in interface <A HREF="../../../../org/apache/xml/utils/XMLString.html">XMLString</A><DT><B>Returns:</B><DD>A double value representation of the string, or return Double.NaN |
| if the string can not be converted.</DL>
|
| </DD>
|
| </DL>
|
| <!-- ========= END OF CLASS DATA ========= -->
|
| <HR>
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <TR ALIGN="center" VALIGN="top">
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XMLStringDefault.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
| </TR>
|
| </TABLE>
|
| </TD>
|
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
| </EM>
|
| </TD>
|
| </TR>
|
|
|
| <TR>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../org/apache/xml/utils/XMLReaderManager.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../org/apache/xml/utils/XMLStringFactory.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="XMLStringDefault.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| Copyright © 2006 Apache XML Project. All Rights Reserved.
|
| </BODY>
|
| </HTML>
|
