<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:44 GMT 2011 -->
<TITLE>
StringValue
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StringValue";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<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="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="../../../../net/sf/saxon/value/StringToDouble11.html" title="class in net.sf.saxon.value"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/value/StringValue.CharacterIterator.html" title="class in net.sf.saxon.value"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/value/StringValue.html" target="_top"><B>FRAMES</B></A>
<A HREF="StringValue.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
net.sf.saxon.value</FONT>
<BR>
Class StringValue</H2>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">net.sf.saxon.value.Value</A><<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A>>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">net.sf.saxon.value.AtomicValue</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.value.StringValue</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../net/sf/saxon/evpull/PullEvent.html" title="interface in net.sf.saxon.evpull">PullEvent</A>, <A HREF="../../../../net/sf/saxon/om/GroundedValue.html" title="interface in net.sf.saxon.om">GroundedValue</A><<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A>>, <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A><<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A>>, <A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A><<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A>>, <A HREF="../../../../net/sf/saxon/type/ConversionResult.html" title="interface in net.sf.saxon.type">ConversionResult</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../net/sf/saxon/value/AnyURIValue.html" title="class in net.sf.saxon.value">AnyURIValue</A>, <A HREF="../../../../net/sf/saxon/value/UntypedAtomicValue.html" title="class in net.sf.saxon.value">UntypedAtomicValue</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>StringValue</B><DT>extends <A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></DL>
</PRE>
<P>
An atomic value of type xs:string. This class is also used for types derived from xs:string.
Subclasses of StringValue are used for xs:untypedAtomic and xs:anyURI values.
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.CharacterIterator.html" title="class in net.sf.saxon.value">StringValue.CharacterIterator</A></B></CODE>
<BR>
CharacterIterator is used to iterate over the characters in a string,
returning them as integers representing the Unicode code-point.</TD>
</TR>
</TABLE>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#EMPTY_STRING">EMPTY_STRING</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#FALSE">FALSE</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#noSurrogates">noSurrogates</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#SINGLE_SPACE">SINGLE_SPACE</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#TRUE">TRUE</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#value">value</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_net.sf.saxon.value.AtomicValue"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class net.sf.saxon.value.<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#typeLabel">typeLabel</A></CODE></TD>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_net.sf.saxon.value.Value"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class net.sf.saxon.value.<A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/value/Value.html#INDETERMINATE_ORDERING">INDETERMINATE_ORDERING</A></CODE></TD>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_net.sf.saxon.om.ValueRepresentation"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from interface net.sf.saxon.om.<A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html#EMPTY_VALUE_ARRAY">EMPTY_VALUE_ARRAY</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#StringValue()">StringValue</A></B>()</CODE>
<BR>
Protected constructor for use by subtypes</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#StringValue(java.lang.CharSequence)">StringValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> value)</CODE>
<BR>
Constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#StringValue(java.lang.CharSequence, net.sf.saxon.type.AtomicType)">StringValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> value,
<A HREF="../../../../net/sf/saxon/type/AtomicType.html" title="interface in net.sf.saxon.type">AtomicType</A> typeLabel)</CODE>
<BR>
Constructor.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</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="../../../../net/sf/saxon/value/StringValue.html#codepointEquals(net.sf.saxon.value.StringValue)">codepointEquals</A></B>(<A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A> other)</CODE>
<BR>
Test whether this StringValue is equal to another under the rules of the codepoint collation</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="../../../../net/sf/saxon/value/StringValue.html#containsSurrogatePairs()">containsSurrogatePairs</A></B>()</CODE>
<BR>
Determine whether the string contains surrogate pairs</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#contract(int[], int)">contract</A></B>(int[] codes,
int used)</CODE>
<BR>
Contract an array of integers containing Unicode codepoints into a Java string</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#copyAsSubType(net.sf.saxon.type.AtomicType)">copyAsSubType</A></B>(<A HREF="../../../../net/sf/saxon/type/AtomicType.html" title="interface in net.sf.saxon.type">AtomicType</A> typeLabel)</CODE>
<BR>
Create a copy of this atomic value, with a different type label</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#diagnosticDisplay(java.lang.String)">diagnosticDisplay</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> s)</CODE>
<BR>
Produce a diagnostic representation of the contents of the 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="../../../../net/sf/saxon/value/StringValue.html#effectiveBooleanValue()">effectiveBooleanValue</A></B>()</CODE>
<BR>
Get the effective boolean value of a 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="../../../../net/sf/saxon/value/StringValue.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</CODE>
<BR>
Determine if two AtomicValues are equal, according to XPath rules.</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="../../../../net/sf/saxon/value/StringValue.html#expand()">expand</A></B>()</CODE>
<BR>
Expand a string containing surrogate pairs into an array of 32-bit characters</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#expand(java.lang.CharSequence)">expand</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> s)</CODE>
<BR>
Expand a string containing surrogate pairs into an array of 32-bit characters</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#getPrimitiveStringValue()">getPrimitiveStringValue</A></B>()</CODE>
<BR>
Get the string value as a CharSequence</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/type/BuiltInAtomicType.html" title="class in net.sf.saxon.type">BuiltInAtomicType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#getPrimitiveType()">getPrimitiveType</A></B>()</CODE>
<BR>
Determine the primitive type of the value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#getSchemaComparable()">getSchemaComparable</A></B>()</CODE>
<BR>
Get a Comparable value that implements the XML Schema comparison semantics for this value.</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="../../../../net/sf/saxon/value/StringValue.html#getStringLength()">getStringLength</A></B>()</CODE>
<BR>
Get the length of this string, as defined in XPath.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#getStringLength(java.lang.CharSequence)">getStringLength</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> s)</CODE>
<BR>
Get the length of a string, as defined in XPath.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#getXPathComparable(boolean, net.sf.saxon.lib.StringCollator, net.sf.saxon.expr.XPathContext)">getXPathComparable</A></B>(boolean ordered,
<A HREF="../../../../net/sf/saxon/lib/StringCollator.html" title="interface in net.sf.saxon.lib">StringCollator</A> collator,
<A HREF="../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Get an object value that implements the XPath equality and ordering comparison semantics for this value.</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="../../../../net/sf/saxon/value/StringValue.html#hashCode()">hashCode</A></B>()</CODE>
<BR>
</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="../../../../net/sf/saxon/value/StringValue.html#isIdentical(net.sf.saxon.value.Value)">isIdentical</A></B>(<A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A> v)</CODE>
<BR>
Determine whether two atomic values are identical, as determined by XML Schema rules.</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="../../../../net/sf/saxon/value/StringValue.html#isKnownToContainNoSurrogates()">isKnownToContainNoSurrogates</A></B>()</CODE>
<BR>
Ask whether the string is known to contain no surrogate pairs.</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="../../../../net/sf/saxon/value/StringValue.html#isZeroLength()">isZeroLength</A></B>()</CODE>
<BR>
Determine whether the string is a zero-length string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/tree/iter/UnfailingIterator.html" title="interface in net.sf.saxon.tree.iter">UnfailingIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#iterateCharacters()">iterateCharacters</A></B>()</CODE>
<BR>
Iterate over a string, returning a sequence of integers representing the Unicode code-point values</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#makeStringValue(java.lang.CharSequence)">makeStringValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> value)</CODE>
<BR>
Factory method.</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="../../../../net/sf/saxon/value/StringValue.html#setContainsNoSurrogates()">setContainsNoSurrogates</A></B>()</CODE>
<BR>
Assert that the string is known to contain no surrogate pairs</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="../../../../net/sf/saxon/value/StringValue.html#setStringValueCS(java.lang.CharSequence)">setStringValueCS</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> value)</CODE>
<BR>
Set the value of the item as a CharSequence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/value/StringValue.html#toString()">toString</A></B>()</CODE>
<BR>
Get string value.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.value.AtomicValue"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class net.sf.saxon.value.<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#asAtomic()">asAtomic</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#checkPermittedContents(net.sf.saxon.type.SchemaType, net.sf.saxon.expr.StaticContext, boolean)">checkPermittedContents</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getCardinality()">getCardinality</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getComponent(int)">getComponent</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getItemType(net.sf.saxon.type.TypeHierarchy)">getItemType</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getLength()">getLength</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getStringValue()">getStringValue</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getStringValueCS()">getStringValueCS</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getTypedValue()">getTypedValue</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getTypeLabel()">getTypeLabel</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#isNaN()">isNaN</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#itemAt(int)">itemAt</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#iterate()">iterate</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#process(net.sf.saxon.expr.XPathContext)">process</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#setTypeLabel(net.sf.saxon.type.AtomicType)">setTypeLabel</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#subsequence(int, int)">subsequence</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.value.Value"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class net.sf.saxon.value.<A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/value/Value.html#asItem()">asItem</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#asItem(net.sf.saxon.om.ValueRepresentation)">asItem</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#asIterator(net.sf.saxon.om.ValueRepresentation)">asIterator</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#asValue(net.sf.saxon.om.ValueRepresentation)">asValue</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#convertToJava(net.sf.saxon.om.Item)">convertToJava</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#fromItem(net.sf.saxon.om.Item)">fromItem</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#getCanonicalLexicalRepresentation()">getCanonicalLexicalRepresentation</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#getIterator(net.sf.saxon.om.ValueRepresentation)">getIterator</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#getSequenceLength(net.sf.saxon.om.ValueRepresentation)">getSequenceLength</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#reduce()">reduce</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="EMPTY_STRING"><!-- --></A><H3>
EMPTY_STRING</H3>
<PRE>
public static final <A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A> <B>EMPTY_STRING</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="SINGLE_SPACE"><!-- --></A><H3>
SINGLE_SPACE</H3>
<PRE>
public static final <A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A> <B>SINGLE_SPACE</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="TRUE"><!-- --></A><H3>
TRUE</H3>
<PRE>
public static final <A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A> <B>TRUE</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="FALSE"><!-- --></A><H3>
FALSE</H3>
<PRE>
public static final <A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A> <B>FALSE</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="value"><!-- --></A><H3>
value</H3>
<PRE>
protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> <B>value</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="noSurrogates"><!-- --></A><H3>
noSurrogates</H3>
<PRE>
protected boolean <B>noSurrogates</B></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="StringValue()"><!-- --></A><H3>
StringValue</H3>
<PRE>
protected <B>StringValue</B>()</PRE>
<DL>
<DD>Protected constructor for use by subtypes
<P>
</DL>
<HR>
<A NAME="StringValue(java.lang.CharSequence)"><!-- --></A><H3>
StringValue</H3>
<PRE>
public <B>StringValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> value)</PRE>
<DL>
<DD>Constructor. Note that although a StringValue may wrap any kind of CharSequence
(usually a String, but it can also be, for example, a StringBuffer), the caller
is responsible for ensuring that the value is immutable.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the String value. Null is taken as equivalent to "".</DL>
</DL>
<HR>
<A NAME="StringValue(java.lang.CharSequence, net.sf.saxon.type.AtomicType)"><!-- --></A><H3>
StringValue</H3>
<PRE>
public <B>StringValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> value,
<A HREF="../../../../net/sf/saxon/type/AtomicType.html" title="interface in net.sf.saxon.type">AtomicType</A> typeLabel)</PRE>
<DL>
<DD>Constructor. Note that although a StringValue may wrap any kind of CharSequence
(usually a String, but it can also be, for example, a StringBuffer), the caller
is responsible for ensuring that the value is immutable.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the String value.<DD><CODE>typeLabel</CODE> - the type of the value to be created. The caller must ensure that this is
a type derived from string and that the string is valid against this type.</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="setContainsNoSurrogates()"><!-- --></A><H3>
setContainsNoSurrogates</H3>
<PRE>
public void <B>setContainsNoSurrogates</B>()</PRE>
<DL>
<DD>Assert that the string is known to contain no surrogate pairs
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="copyAsSubType(net.sf.saxon.type.AtomicType)"><!-- --></A><H3>
copyAsSubType</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A> <B>copyAsSubType</B>(<A HREF="../../../../net/sf/saxon/type/AtomicType.html" title="interface in net.sf.saxon.type">AtomicType</A> typeLabel)</PRE>
<DL>
<DD>Create a copy of this atomic value, with a different type label
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#copyAsSubType(net.sf.saxon.type.AtomicType)">copyAsSubType</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>typeLabel</CODE> - the type label of the new copy. The caller is responsible for checking that
the value actually conforms to this type.
<DT><B>Returns:</B><DD>the copied value</DL>
</DD>
</DL>
<HR>
<A NAME="getPrimitiveType()"><!-- --></A><H3>
getPrimitiveType</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/type/BuiltInAtomicType.html" title="class in net.sf.saxon.type">BuiltInAtomicType</A> <B>getPrimitiveType</B>()</PRE>
<DL>
<DD>Determine the primitive type of the value. This delivers the same answer as
getItemType().getPrimitiveItemType(). The primitive types are
the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration,
and xs:untypedAtomic. For external objects, the result is AnyAtomicType.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getPrimitiveType()">getPrimitiveType</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the primitive type</DL>
</DD>
</DL>
<HR>
<A NAME="makeStringValue(java.lang.CharSequence)"><!-- --></A><H3>
makeStringValue</H3>
<PRE>
public static <A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A> <B>makeStringValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> value)</PRE>
<DL>
<DD>Factory method. Unlike the constructor, this avoids creating a new StringValue in the case
of a zero-length string (and potentially other strings, in future)
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the String value. Null is taken as equivalent to "".
<DT><B>Returns:</B><DD>the corresponding StringValue</DL>
</DD>
</DL>
<HR>
<A NAME="getPrimitiveStringValue()"><!-- --></A><H3>
getPrimitiveStringValue</H3>
<PRE>
public final <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> <B>getPrimitiveStringValue</B>()</PRE>
<DL>
<DD>Get the string value as a CharSequence
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getPrimitiveStringValue()">getPrimitiveStringValue</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the value converted to a string according to the rules for the primitive type</DL>
</DD>
</DL>
<HR>
<A NAME="setStringValueCS(java.lang.CharSequence)"><!-- --></A><H3>
setStringValueCS</H3>
<PRE>
public final void <B>setStringValueCS</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> value)</PRE>
<DL>
<DD>Set the value of the item as a CharSequence.
<p><b>For system use only. In principle, a StringValue is immutable. However, in special circumstances,
if it is newly constructed, the content can be changed to reflect the effect of the whiteSpace facet.</b></p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the value of the string</DL>
</DD>
</DL>
<HR>
<A NAME="getStringLength()"><!-- --></A><H3>
getStringLength</H3>
<PRE>
public int <B>getStringLength</B>()</PRE>
<DL>
<DD>Get the length of this string, as defined in XPath. This is not the same as the Java length,
as a Unicode surrogate pair counts as a single character
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the length of the string in Unicode code points</DL>
</DD>
</DL>
<HR>
<A NAME="getStringLength(java.lang.CharSequence)"><!-- --></A><H3>
getStringLength</H3>
<PRE>
public static int <B>getStringLength</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> s)</PRE>
<DL>
<DD>Get the length of a string, as defined in XPath. This is not the same as the Java length,
as a Unicode surrogate pair counts as a single character.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>s</CODE> - The string whose length is required
<DT><B>Returns:</B><DD>the length of the string in Unicode code points</DL>
</DD>
</DL>
<HR>
<A NAME="isZeroLength()"><!-- --></A><H3>
isZeroLength</H3>
<PRE>
public boolean <B>isZeroLength</B>()</PRE>
<DL>
<DD>Determine whether the string is a zero-length string. This may
be more efficient than testing whether the length is equal to zero
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the string is zero length</DL>
</DD>
</DL>
<HR>
<A NAME="containsSurrogatePairs()"><!-- --></A><H3>
containsSurrogatePairs</H3>
<PRE>
public boolean <B>containsSurrogatePairs</B>()</PRE>
<DL>
<DD>Determine whether the string contains surrogate pairs
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the string contains any non-BMP characters</DL>
</DD>
</DL>
<HR>
<A NAME="isKnownToContainNoSurrogates()"><!-- --></A><H3>
isKnownToContainNoSurrogates</H3>
<PRE>
public boolean <B>isKnownToContainNoSurrogates</B>()</PRE>
<DL>
<DD>Ask whether the string is known to contain no surrogate pairs.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if it is known to contain no surrogates, false if the answer is not known</DL>
</DD>
</DL>
<HR>
<A NAME="iterateCharacters()"><!-- --></A><H3>
iterateCharacters</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/tree/iter/UnfailingIterator.html" title="interface in net.sf.saxon.tree.iter">UnfailingIterator</A> <B>iterateCharacters</B>()</PRE>
<DL>
<DD>Iterate over a string, returning a sequence of integers representing the Unicode code-point values
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an iterator over the characters (Unicode code points) in the string</DL>
</DD>
</DL>
<HR>
<A NAME="expand()"><!-- --></A><H3>
expand</H3>
<PRE>
public int[] <B>expand</B>()</PRE>
<DL>
<DD>Expand a string containing surrogate pairs into an array of 32-bit characters
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an array of integers representing the Unicode code points</DL>
</DD>
</DL>
<HR>
<A NAME="expand(java.lang.CharSequence)"><!-- --></A><H3>
expand</H3>
<PRE>
public static int[] <B>expand</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> s)</PRE>
<DL>
<DD>Expand a string containing surrogate pairs into an array of 32-bit characters
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>s</CODE> - the string to be expanded
<DT><B>Returns:</B><DD>an array of integers representing the Unicode code points</DL>
</DD>
</DL>
<HR>
<A NAME="contract(int[], int)"><!-- --></A><H3>
contract</H3>
<PRE>
public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> <B>contract</B>(int[] codes,
int used)</PRE>
<DL>
<DD>Contract an array of integers containing Unicode codepoints into a Java string
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>codes</CODE> - an array of integers representing the Unicode code points<DD><CODE>used</CODE> - the number of items in the array that are actually used
<DT><B>Returns:</B><DD>the constructed string</DL>
</DD>
</DL>
<HR>
<A NAME="getXPathComparable(boolean, net.sf.saxon.lib.StringCollator, net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
getXPathComparable</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>getXPathComparable</B>(boolean ordered,
<A HREF="../../../../net/sf/saxon/lib/StringCollator.html" title="interface in net.sf.saxon.lib">StringCollator</A> collator,
<A HREF="../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</PRE>
<DL>
<DD>Get an object value that implements the XPath equality and ordering comparison semantics for this value.
If the ordered parameter is set to true, the result will be a Comparable and will support a compareTo()
method with the semantics of the XPath lt/gt operator, provided that the other operand is also obtained
using the getXPathComparable() method. In all cases the result will support equals() and hashCode() methods
that support the semantics of the XPath eq operator, again provided that the other operand is also obtained
using the getXPathComparable() method. A context argument is supplied for use in cases where the comparison
semantics are context-sensitive, for example where they depend on the implicit timezone or the default
collation.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getXPathComparable(boolean, net.sf.saxon.lib.StringCollator, net.sf.saxon.expr.XPathContext)">getXPathComparable</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ordered</CODE> - true if an ordered comparison is required. In this case the result is null if the
type is unordered; in other cases the returned value will be a Comparable.<DD><CODE>collator</CODE> - Collation to be used for comparing strings<DD><CODE>context</CODE> - the XPath dynamic evaluation context, used in cases where the comparison is context
sensitive
<DT><B>Returns:</B><DD>an Object whose equals() and hashCode() methods implement the XPath comparison semantics
with respect to this atomic value. If ordered is specified, the result will either be null if
no ordering is defined, or will be a Comparable</DL>
</DD>
</DL>
<HR>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</PRE>
<DL>
<DD>Determine if two AtomicValues are equal, according to XPath rules. (This method
is not used for string comparisons, which are always under the control of a collation.
If we get here, it's because there's a type error in the comparison.)
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#equals(java.lang.Object)">equals</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>other</CODE> - the other value
<DT><B>Returns:</B><DD>true if the other operand is an atomic value and the two values are equal as defined
by the XPath eq operator
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</A></CODE> - always</DL>
</DD>
</DL>
<HR>
<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
public int <B>hashCode</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/Value.html#hashCode()">hashCode</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A><<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A>></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="codepointEquals(net.sf.saxon.value.StringValue)"><!-- --></A><H3>
codepointEquals</H3>
<PRE>
public boolean <B>codepointEquals</B>(<A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A> other)</PRE>
<DL>
<DD>Test whether this StringValue is equal to another under the rules of the codepoint collation
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>other</CODE> - the value to be compared with this value
<DT><B>Returns:</B><DD>true if the strings are equal on a codepoint-by-codepoint basis</DL>
</DD>
</DL>
<HR>
<A NAME="effectiveBooleanValue()"><!-- --></A><H3>
effectiveBooleanValue</H3>
<PRE>
public boolean <B>effectiveBooleanValue</B>()</PRE>
<DL>
<DD>Get the effective boolean value of a string
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#effectiveBooleanValue()">effectiveBooleanValue</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the string has length greater than zero</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#toString()">AtomicValue</A></CODE></B></DD>
<DD>Get string value. In general toString() for an atomic value displays the value as it would be
written in XPath: that is, as a literal if available, or as a call on a constructor function
otherwise.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#toString()">toString</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSchemaComparable()"><!-- --></A><H3>
getSchemaComparable</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A> <B>getSchemaComparable</B>()</PRE>
<DL>
<DD>Get a Comparable value that implements the XML Schema comparison semantics for this value.
Returns null if the value is not comparable according to XML Schema rules. This implementation
returns the underlying Java string, which works because strings will only be compared for
equality, not for ordering, and the equality rules for strings in XML schema are the same as in Java.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getSchemaComparable()">getSchemaComparable</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a Comparable that follows XML Schema comparison rules</DL>
</DD>
</DL>
<HR>
<A NAME="isIdentical(net.sf.saxon.value.Value)"><!-- --></A><H3>
isIdentical</H3>
<PRE>
public boolean <B>isIdentical</B>(<A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A> v)</PRE>
<DL>
<DD>Determine whether two atomic values are identical, as determined by XML Schema rules. This is a stronger
test than equality (even schema-equality); for example two dateTime values are not identical unless
they are in the same timezone.
<p>Note that even this check ignores the type annotation of the value. The integer 3 and the short 3
are considered identical, even though they are not fully interchangeable. "Identical" means the
same point in the value space, regardless of type annotation.</p>
<p>NaN is identical to itself.</p>
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#isIdentical(net.sf.saxon.value.Value)">isIdentical</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>v</CODE> - the other value to be compared with this one
<DT><B>Returns:</B><DD>true if the two values are identical, false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="diagnosticDisplay(java.lang.String)"><!-- --></A><H3>
diagnosticDisplay</H3>
<PRE>
public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>diagnosticDisplay</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> s)</PRE>
<DL>
<DD>Produce a diagnostic representation of the contents of the string
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>s</CODE> - the string
<DT><B>Returns:</B><DD>a string in which non-Ascii-printable characters are replaced by \ uXXXX escapes</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<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="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="../../../../net/sf/saxon/value/StringToDouble11.html" title="class in net.sf.saxon.value"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/value/StringValue.CharacterIterator.html" title="class in net.sf.saxon.value"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/value/StringValue.html" target="_top"><B>FRAMES</B></A>
<A HREF="StringValue.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
