diff options
Diffstat (limited to 'trunk/infrastructure/rhino1_7R1/javadoc/org/mozilla/javascript/ClassCache.html')
| -rw-r--r-- | trunk/infrastructure/rhino1_7R1/javadoc/org/mozilla/javascript/ClassCache.html | 445 |
1 files changed, 445 insertions, 0 deletions
diff --git a/trunk/infrastructure/rhino1_7R1/javadoc/org/mozilla/javascript/ClassCache.html b/trunk/infrastructure/rhino1_7R1/javadoc/org/mozilla/javascript/ClassCache.html new file mode 100644 index 0000000..8d8b3ef --- /dev/null +++ b/trunk/infrastructure/rhino1_7R1/javadoc/org/mozilla/javascript/ClassCache.html @@ -0,0 +1,445 @@ +<!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) on Thu Mar 06 17:19:14 EST 2008 --> +<TITLE> +ClassCache (Rhino) +</TITLE> + +<META NAME="date" CONTENT="2008-03-06"> + +<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="ClassCache (Rhino)"; + } +} +</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="../../../org/mozilla/javascript/Callable.html" title="interface in org.mozilla.javascript"><B>PREV CLASS</B></A> + <A HREF="../../../org/mozilla/javascript/ClassShutter.html" title="interface in org.mozilla.javascript"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/mozilla/javascript/ClassCache.html" target="_top"><B>FRAMES</B></A> + <A HREF="ClassCache.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 | <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> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.mozilla.javascript</FONT> +<BR> +Class ClassCache</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.mozilla.javascript.ClassCache</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>ClassCache</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +Cache of generated classes and data structures to access Java runtime + from JavaScript. +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>Rhino 1.5 Release 5</DD> +<DT><B>Author:</B></DT> + <DD>Igor Bukanov</DD> +</DL> +<HR> + +<P> + +<!-- ======== 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><CODE><B><A HREF="../../../org/mozilla/javascript/ClassCache.html#ClassCache()">ClassCache</A></B>()</CODE> + +<BR> + </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="../../../org/mozilla/javascript/ClassCache.html#associate(org.mozilla.javascript.ScriptableObject)">associate</A></B>(<A HREF="../../../org/mozilla/javascript/ScriptableObject.html" title="class in org.mozilla.javascript">ScriptableObject</A> topScope)</CODE> + +<BR> + Associate ClassCache object with the given top-level scope.</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/mozilla/javascript/ClassCache.html#clearCaches()">clearCaches</A></B>()</CODE> + +<BR> + Empty caches of generated Java classes and Java reflection information.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../org/mozilla/javascript/ClassCache.html" title="class in org.mozilla.javascript">ClassCache</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/ClassCache.html#get(org.mozilla.javascript.Scriptable)">get</A></B>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope)</CODE> + +<BR> + Search for ClassCache object in the given scope.</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/mozilla/javascript/ClassCache.html#isCachingEnabled()">isCachingEnabled</A></B>()</CODE> + +<BR> + Check if generated Java classes and Java reflection information + is cached.</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/mozilla/javascript/ClassCache.html#isInvokerOptimizationEnabled()">isInvokerOptimizationEnabled</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> <I>The method always returns false.</I></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/mozilla/javascript/ClassCache.html#newClassSerialNumber()">newClassSerialNumber</A></B>()</CODE> + +<BR> + Internal engine method to return serial number for generated classes + to ensure name uniqueness.</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/mozilla/javascript/ClassCache.html#setCachingEnabled(boolean)">setCachingEnabled</A></B>(boolean enabled)</CODE> + +<BR> + Set whether to cache some values.</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/mozilla/javascript/ClassCache.html#setInvokerOptimizationEnabled(boolean)">setInvokerOptimizationEnabled</A></B>(boolean enabled)</CODE> + +<BR> + <B>Deprecated.</B> <I>The method does nothing. + Invoker optimization is no longer used by Rhino. + On modern JDK like 1.4 or 1.5 the disadvantages of the optimization + like increased memory usage or longer initialization time overweight + small speed increase that can be gained using generated proxy class + to replace reflection.</I></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.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= 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="ClassCache()"><!-- --></A><H3> +ClassCache</H3> +<PRE> +public <B>ClassCache</B>()</PRE> +<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="get(org.mozilla.javascript.Scriptable)"><!-- --></A><H3> +get</H3> +<PRE> +public static <A HREF="../../../org/mozilla/javascript/ClassCache.html" title="class in org.mozilla.javascript">ClassCache</A> <B>get</B>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope)</PRE> +<DL> +<DD>Search for ClassCache object in the given scope. + The method first calls + <A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getTopLevelScope(org.mozilla.javascript.Scriptable)"><CODE>ScriptableObject.getTopLevelScope(Scriptable scope)</CODE></A> + to get the top most scope and then tries to locate associated + ClassCache object in the prototype chain of the top scope. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>scope</CODE> - scope to search for ClassCache object. +<DT><B>Returns:</B><DD>previously associated ClassCache object or a new instance of + ClassCache if no ClassCache object was found.<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/ClassCache.html#associate(org.mozilla.javascript.ScriptableObject)"><CODE>associate(ScriptableObject topScope)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="associate(org.mozilla.javascript.ScriptableObject)"><!-- --></A><H3> +associate</H3> +<PRE> +public boolean <B>associate</B>(<A HREF="../../../org/mozilla/javascript/ScriptableObject.html" title="class in org.mozilla.javascript">ScriptableObject</A> topScope)</PRE> +<DL> +<DD>Associate ClassCache object with the given top-level scope. + The ClassCache object can only be associated with the given scope once. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>topScope</CODE> - scope to associate this ClassCache object with. +<DT><B>Returns:</B><DD>true if no previous ClassCache objects were embedded into + the scope and this ClassCache were successfully associated + or false otherwise.<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/ClassCache.html#get(org.mozilla.javascript.Scriptable)"><CODE>get(Scriptable scope)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="clearCaches()"><!-- --></A><H3> +clearCaches</H3> +<PRE> +public void <B>clearCaches</B>()</PRE> +<DL> +<DD>Empty caches of generated Java classes and Java reflection information. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isCachingEnabled()"><!-- --></A><H3> +isCachingEnabled</H3> +<PRE> +public final boolean <B>isCachingEnabled</B>()</PRE> +<DL> +<DD>Check if generated Java classes and Java reflection information + is cached. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setCachingEnabled(boolean)"><!-- --></A><H3> +setCachingEnabled</H3> +<PRE> +public void <B>setCachingEnabled</B>(boolean enabled)</PRE> +<DL> +<DD>Set whether to cache some values. + <p> + By default, the engine will cache the results of + <tt>Class.getMethods()</tt> and similar calls. + This can speed execution dramatically, but increases the memory + footprint. Also, with caching enabled, references may be held to + objects past the lifetime of any real usage. + <p> + If caching is enabled and this method is called with a + <code>false</code> argument, the caches will be emptied. + <p> + Caching is enabled by default. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>enabled</CODE> - if true, caching is enabled<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/ClassCache.html#clearCaches()"><CODE>clearCaches()</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="isInvokerOptimizationEnabled()"><!-- --></A><H3> +isInvokerOptimizationEnabled</H3> +<PRE> +public boolean <B>isInvokerOptimizationEnabled</B>()</PRE> +<DL> +<DD><B>Deprecated.</B> <I>The method always returns false.</I> +<P> +<DD><DL> +<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/ClassCache.html#setInvokerOptimizationEnabled(boolean)"><CODE>setInvokerOptimizationEnabled(boolean enabled)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="setInvokerOptimizationEnabled(boolean)"><!-- --></A><H3> +setInvokerOptimizationEnabled</H3> +<PRE> +public void <B>setInvokerOptimizationEnabled</B>(boolean enabled)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>The method does nothing. + Invoker optimization is no longer used by Rhino. + On modern JDK like 1.4 or 1.5 the disadvantages of the optimization + like increased memory usage or longer initialization time overweight + small speed increase that can be gained using generated proxy class + to replace reflection.</I> +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="newClassSerialNumber()"><!-- --></A><H3> +newClassSerialNumber</H3> +<PRE> +public final int <B>newClassSerialNumber</B>()</PRE> +<DL> +<DD>Internal engine method to return serial number for generated classes + to ensure name uniqueness. +<P> +<DD><DL> +</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="../../../org/mozilla/javascript/Callable.html" title="interface in org.mozilla.javascript"><B>PREV CLASS</B></A> + <A HREF="../../../org/mozilla/javascript/ClassShutter.html" title="interface in org.mozilla.javascript"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/mozilla/javascript/ClassCache.html" target="_top"><B>FRAMES</B></A> + <A HREF="ClassCache.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 | <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> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> |