--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
+<!--NewPage-->\r
+<HTML>\r
+<HEAD>\r
+<!-- Generated by javadoc (build 1.5.0_11) on Tue Apr 10 15:02:46 UTC 2007 -->\r
+<TITLE>\r
+ResourceReference\r
+</TITLE>\r
+\r
+<META NAME="keywords" CONTENT="org.w3c.tools.resources.ResourceReference interface">\r
+\r
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">\r
+\r
+<SCRIPT type="text/javascript">\r
+function windowTitle()\r
+{\r
+ parent.document.title="ResourceReference";\r
+}\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+</NOSCRIPT>\r
+\r
+</HEAD>\r
+\r
+<BODY BGCOLOR="white" onload="windowTitle();">\r
+\r
+\r
+<!-- ========= START OF TOP NAVBAR ======= -->\r
+<A NAME="navbar_top"><!-- --></A>\r
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_top_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+ <TR ALIGN="center" VALIGN="top">\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>\r
+ </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+ <A HREF="../../../../org/w3c/tools/resources/ResourceFrame.html" title="class in org.w3c.tools.resources"><B>PREV CLASS</B></A> \r
+ <A HREF="../../../../org/w3c/tools/resources/ResourceShadower.html" title="interface in org.w3c.tools.resources"><B>NEXT CLASS</B></A></FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+ <A HREF="../../../../index.html?org/w3c/tools/resources/ResourceReference.html" target="_top"><B>FRAMES</B></A> \r
+ <A HREF="ResourceReference.html" target="_top"><B>NO FRAMES</B></A> \r
+ <SCRIPT type="text/javascript">\r
+ <!--\r
+ if(window==top) {\r
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+ }\r
+ //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_top"></A>\r
+<!-- ========= END OF TOP NAVBAR ========= -->\r
+\r
+<HR>\r
+<!-- ======== START OF CLASS DATA ======== -->\r
+<H2>\r
+<FONT SIZE="-1">\r
+org.w3c.tools.resources</FONT>\r
+<BR>\r
+Interface ResourceReference</H2>\r
+<DL>\r
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/w3c/tools/resources/DummyResourceReference.html" title="class in org.w3c.tools.resources">DummyResourceReference</A></DD>\r
+</DL>\r
+<HR>\r
+<DL>\r
+<DT><PRE>public interface <B>ResourceReference</B></DL>\r
+</PRE>\r
+\r
+<P>\r
+Resolving a resource provides back a resource reference.\r
+ Resource <em>references</em> are the basis for handling an eventual\r
+ cache between the store of the resource and its memory image (ie\r
+ the resource instance).\r
+ <p>All resource spaces must provide some notion of resource reference.\r
+ <p>A typical access to a resource looks like:\r
+ <pre>\r
+ ResourceReference rr = space.lookup("/x/y/z");\r
+ try {\r
+ Resource r = rr.lock();\r
+ // Fiddle with the resource:\r
+ r.setValue("foo", new Integer(10));\r
+ } catch (InvalidResourceException e) {\r
+ System.out.println(e.getMessage());\r
+ } finally {\r
+ // Make sure to unlock the reference:\r
+ rr.unlock();\r
+ </pre>\r
+<P>\r
+\r
+<P>\r
+<HR>\r
+\r
+<P>\r
+\r
+<!-- ========== METHOD SUMMARY =========== -->\r
+\r
+<A NAME="method_summary"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
+<B>Method Summary</B></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> boolean</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../org/w3c/tools/resources/ResourceReference.html#isLocked()">isLocked</A></B>()</CODE>\r
+\r
+<BR>\r
+ Is that resource reference locked ?</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> <A HREF="../../../../org/w3c/tools/resources/Resource.html" title="class in org.w3c.tools.resources">Resource</A></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../org/w3c/tools/resources/ResourceReference.html#lock()">lock</A></B>()</CODE>\r
+\r
+<BR>\r
+ Lock the refered resource in memory.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../org/w3c/tools/resources/ResourceReference.html#nbLock()">nbLock</A></B>()</CODE>\r
+\r
+<BR>\r
+ How many locks?</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> void</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../org/w3c/tools/resources/ResourceReference.html#unlock()">unlock</A></B>()</CODE>\r
+\r
+<BR>\r
+ Unlock that resource from memory.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> <A HREF="../../../../org/w3c/tools/resources/Resource.html" title="class in org.w3c.tools.resources">Resource</A></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../org/w3c/tools/resources/ResourceReference.html#unsafeLock()">unsafeLock</A></B>()</CODE>\r
+\r
+<BR>\r
+ Lock the refered resource in memory.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> void</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../org/w3c/tools/resources/ResourceReference.html#updateContext(org.w3c.tools.resources.ResourceContext)">updateContext</A></B>(<A HREF="../../../../org/w3c/tools/resources/ResourceContext.html" title="class in org.w3c.tools.resources">ResourceContext</A> ctxt)</CODE>\r
+\r
+<BR>\r
+ update the cached context of that reference.</TD>\r
+</TR>\r
+</TABLE>\r
+ \r
+<P>\r
+\r
+<!-- ============ METHOD DETAIL ========== -->\r
+\r
+<A NAME="method_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Method Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="lock()"><!-- --></A><H3>\r
+lock</H3>\r
+<PRE>\r
+<A HREF="../../../../org/w3c/tools/resources/Resource.html" title="class in org.w3c.tools.resources">Resource</A> <B>lock</B>()\r
+ throws <A HREF="../../../../org/w3c/tools/resources/InvalidResourceException.html" title="class in org.w3c.tools.resources">InvalidResourceException</A></PRE>\r
+<DL>\r
+<DD>Lock the refered resource in memory.\r
+<P>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>A real pointer to the resource.\r
+<DT><B>Throws:</B>\r
+<DD><CODE><A HREF="../../../../org/w3c/tools/resources/InvalidResourceException.html" title="class in org.w3c.tools.resources">InvalidResourceException</A></CODE> - is thrown if the resource is\r
+ invalid (has been deleted or everything else).</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="unsafeLock()"><!-- --></A><H3>\r
+unsafeLock</H3>\r
+<PRE>\r
+<A HREF="../../../../org/w3c/tools/resources/Resource.html" title="class in org.w3c.tools.resources">Resource</A> <B>unsafeLock</B>()\r
+ throws <A HREF="../../../../org/w3c/tools/resources/InvalidResourceException.html" title="class in org.w3c.tools.resources">InvalidResourceException</A></PRE>\r
+<DL>\r
+<DD>Lock the refered resource in memory.\r
+ NOTE, this version is NOT using a synchronized call and therefore\r
+ must be used with extreme caution. Basically it must be used only\r
+ when a backward locking is needed\r
+<P>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>A real pointer to the resource.\r
+<DT><B>Throws:</B>\r
+<DD><CODE><A HREF="../../../../org/w3c/tools/resources/InvalidResourceException.html" title="class in org.w3c.tools.resources">InvalidResourceException</A></CODE> - is thrown if the resource is\r
+ invalid (has been deleted or everything else).</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="unlock()"><!-- --></A><H3>\r
+unlock</H3>\r
+<PRE>\r
+void <B>unlock</B>()</PRE>\r
+<DL>\r
+<DD>Unlock that resource from memory.\r
+<P>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="isLocked()"><!-- --></A><H3>\r
+isLocked</H3>\r
+<PRE>\r
+boolean <B>isLocked</B>()</PRE>\r
+<DL>\r
+<DD>Is that resource reference locked ?\r
+<P>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>a boolean.</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="nbLock()"><!-- --></A><H3>\r
+nbLock</H3>\r
+<PRE>\r
+int <B>nbLock</B>()</PRE>\r
+<DL>\r
+<DD>How many locks?\r
+<P>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>an int.</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="updateContext(org.w3c.tools.resources.ResourceContext)"><!-- --></A><H3>\r
+updateContext</H3>\r
+<PRE>\r
+void <B>updateContext</B>(<A HREF="../../../../org/w3c/tools/resources/ResourceContext.html" title="class in org.w3c.tools.resources">ResourceContext</A> ctxt)</PRE>\r
+<DL>\r
+<DD>update the cached context of that reference.\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>ctxt</CODE> - the new ResourceContext.</DL>\r
+</DD>\r
+</DL>\r
+<!-- ========= END OF CLASS DATA ========= -->\r
+<HR>\r
+\r
+\r
+<!-- ======= START OF BOTTOM NAVBAR ====== -->\r
+<A NAME="navbar_bottom"><!-- --></A>\r
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_bottom_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+ <TR ALIGN="center" VALIGN="top">\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>\r
+ </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+ <A HREF="../../../../org/w3c/tools/resources/ResourceFrame.html" title="class in org.w3c.tools.resources"><B>PREV CLASS</B></A> \r
+ <A HREF="../../../../org/w3c/tools/resources/ResourceShadower.html" title="interface in org.w3c.tools.resources"><B>NEXT CLASS</B></A></FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+ <A HREF="../../../../index.html?org/w3c/tools/resources/ResourceReference.html" target="_top"><B>FRAMES</B></A> \r
+ <A HREF="ResourceReference.html" target="_top"><B>NO FRAMES</B></A> \r
+ <SCRIPT type="text/javascript">\r
+ <!--\r
+ if(window==top) {\r
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+ }\r
+ //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_bottom"></A>\r
+<!-- ======== END OF BOTTOM NAVBAR ======= -->\r
+\r
+<HR>\r
+\r
+</BODY>\r
+</HTML>\r
projects / Benchmarks_CSolver.git / blobdiff