<!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:41 GMT 2011 -->
<TITLE>
ConversionResult
</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="ConversionResult";
}
}
</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/type/ComplexType.html" title="interface in net.sf.saxon.type"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/type/Converter.html" title="class in net.sf.saxon.type"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/type/ConversionResult.html" target="_top"><B>FRAMES</B></A>
<A HREF="ConversionResult.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <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.type</FONT>
<BR>
Interface ConversionResult</H2>
<DL>
<DT><B>All Known Implementing Classes:</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/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A>, <A HREF="../../../../net/sf/saxon/value/Base64BinaryValue.html" title="class in net.sf.saxon.value">Base64BinaryValue</A>, <A HREF="../../../../net/sf/saxon/value/BigIntegerValue.html" title="class in net.sf.saxon.value">BigIntegerValue</A>, <A HREF="../../../../net/sf/saxon/value/BooleanValue.html" title="class in net.sf.saxon.value">BooleanValue</A>, <A HREF="../../../../net/sf/saxon/value/CalendarValue.html" title="class in net.sf.saxon.value">CalendarValue</A>, <A HREF="../../../../net/sf/saxon/value/DateTimeValue.html" title="class in net.sf.saxon.value">DateTimeValue</A>, <A HREF="../../../../net/sf/saxon/value/DateValue.html" title="class in net.sf.saxon.value">DateValue</A>, <A HREF="../../../../net/sf/saxon/value/DayTimeDurationValue.html" title="class in net.sf.saxon.value">DayTimeDurationValue</A>, <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A>, <A HREF="../../../../net/sf/saxon/value/DoubleValue.html" title="class in net.sf.saxon.value">DoubleValue</A>, <A HREF="../../../../net/sf/saxon/value/DurationValue.html" title="class in net.sf.saxon.value">DurationValue</A>, <A HREF="../../../../net/sf/saxon/value/FloatValue.html" title="class in net.sf.saxon.value">FloatValue</A>, <A HREF="../../../../net/sf/saxon/value/GDateValue.html" title="class in net.sf.saxon.value">GDateValue</A>, <A HREF="../../../../net/sf/saxon/value/GDayValue.html" title="class in net.sf.saxon.value">GDayValue</A>, <A HREF="../../../../net/sf/saxon/value/GMonthDayValue.html" title="class in net.sf.saxon.value">GMonthDayValue</A>, <A HREF="../../../../net/sf/saxon/value/GMonthValue.html" title="class in net.sf.saxon.value">GMonthValue</A>, <A HREF="../../../../net/sf/saxon/value/GYearMonthValue.html" title="class in net.sf.saxon.value">GYearMonthValue</A>, <A HREF="../../../../net/sf/saxon/value/GYearValue.html" title="class in net.sf.saxon.value">GYearValue</A>, <A HREF="../../../../net/sf/saxon/value/HexBinaryValue.html" title="class in net.sf.saxon.value">HexBinaryValue</A>, <A HREF="../../../../net/sf/saxon/value/Int64Value.html" title="class in net.sf.saxon.value">Int64Value</A>, <A HREF="../../../../net/sf/saxon/value/IntegerValue.html" title="class in net.sf.saxon.value">IntegerValue</A>, <A HREF="../../../../net/sf/saxon/value/NotationValue.html" title="class in net.sf.saxon.value">NotationValue</A>, <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A>, <A HREF="../../../../net/sf/saxon/value/ObjectValue.html" title="class in net.sf.saxon.value">ObjectValue</A>, <A HREF="../../../../net/sf/saxon/value/QNameValue.html" title="class in net.sf.saxon.value">QNameValue</A>, <A HREF="../../../../net/sf/saxon/value/QualifiedNameValue.html" title="class in net.sf.saxon.value">QualifiedNameValue</A>, <A HREF="../../../../net/sf/saxon/value/StringValue.html" title="class in net.sf.saxon.value">StringValue</A>, <A HREF="../../../../net/sf/saxon/value/TimeValue.html" title="class in net.sf.saxon.value">TimeValue</A>, <A HREF="../../../../net/sf/saxon/expr/flwor/Tuple.html" title="class in net.sf.saxon.expr.flwor">Tuple</A>, <A HREF="../../../../net/sf/saxon/value/UntypedAtomicValue.html" title="class in net.sf.saxon.value">UntypedAtomicValue</A>, <A HREF="../../../../net/sf/saxon/type/ValidationFailure.html" title="class in net.sf.saxon.type">ValidationFailure</A>, <A HREF="../../../../net/sf/saxon/value/YearMonthDurationValue.html" title="class in net.sf.saxon.value">YearMonthDurationValue</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>ConversionResult</B></DL>
</PRE>
<P>
This is a marker interface used as the result methods that convert or cast values from one type
to another. It is implemented by AtomicValue, which indicates a successful conversion, and by
ValidationFailure, which indicates an unsuccessful conversion. An unsuccessful conversion does not
throw an exception because exceptions are expensive and should not be used on success paths. For example
when validating a union, conversion failures are to be expected.
<P>
<P>
<HR>
<P>
<!-- ========== 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> <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/type/ConversionResult.html#asAtomic()">asAtomic</A></B>()</CODE>
<BR>
Calling this method on a ConversionResult returns the AtomicValue that results
from the conversion if the conversion was successful, and throws a ValidationException
explaining the conversion error otherwise.</TD>
</TR>
</TABLE>
<P>
<!-- ============ 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="asAtomic()"><!-- --></A><H3>
asAtomic</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A> <B>asAtomic</B>()
throws <A HREF="../../../../net/sf/saxon/type/ValidationException.html" title="class in net.sf.saxon.type">ValidationException</A></PRE>
<DL>
<DD>Calling this method on a ConversionResult returns the AtomicValue that results
from the conversion if the conversion was successful, and throws a ValidationException
explaining the conversion error otherwise.
<p>Use this method if you are calling a conversion method that returns a ConversionResult,
and if you want to throw an exception if the conversion fails.</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the atomic value that results from the conversion if the conversion was successful
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/type/ValidationException.html" title="class in net.sf.saxon.type">ValidationException</A></CODE> - if the conversion was not successful</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/type/ComplexType.html" title="interface in net.sf.saxon.type"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/type/Converter.html" title="class in net.sf.saxon.type"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/type/ConversionResult.html" target="_top"><B>FRAMES</B></A>
<A HREF="ConversionResult.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <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>
