Added: commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/ProxyMap.html URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/ProxyMap.html?rev=1422422&view=auto ============================================================================== --- commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/ProxyMap.html (added) +++ commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/ProxyMap.html Sat Dec 15 23:43:02 2012 @@ -0,0 +1,588 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc on Sat May 29 13:55:32 BST 2004 --> +<TITLE> +ProxyMap (Collections 2.1.1 release API) +</TITLE> +<META NAME="keywords" CONTENT="org.apache.commons.collections.ProxyMap,ProxyMap class"> +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> +</HEAD> +<SCRIPT> +function asd() +{ +parent.document.title="ProxyMap (Collections 2.1.1 release API)"; +} +</SCRIPT> +<BODY BGCOLOR="white" onload="asd();"> + +<!-- ========== START OF NAVBAR ========== --> +<A NAME="navbar_top"><!-- --></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ProxyMap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/commons/collections/ProxyListIterator.html"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> + <A HREF="ProxyMap.html" TARGET="_top"><B>NO FRAMES</B></A> + +<SCRIPT> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> +<A HREF="../../../../allclasses-noframe.html" TARGET=""><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> +<!-- =========== END OF NAVBAR =========== --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.commons.collections</FONT> +<BR> +Class ProxyMap</H2> +<PRE> +java.lang.Object + | + +--<B>org.apache.commons.collections.ProxyMap</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.util.Map</DD> +</DL> +<HR> +<DL> +<DT>public abstract class <B>ProxyMap</B><DT>extends java.lang.Object<DT>implements java.util.Map</DL> + +<P> +<p>This <code>Map</code> wraps another <code>Map</code> + implementation, using the wrapped instance for its default + implementation. This class is used as a framework on which to + build to extensions for its wrapped <code>Map</code> object which + would be unavailable or inconvenient via sub-classing (but usable + via composition).</p> + + <p>An example use case is where the wrapped <code>Map</code> needs + synchronization (to make it thread-safe), but the <code>Map</code> + returned by <code>Collections.synchronizedMap(map)</code> + hides part of <code>map</code>'s public interface.</p> +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>2.0</DD> +<DT><B>Author:</B></DT> + <DD><a href="mailto:[email protected]";>Daniel Rall</a></DD> +</DL> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + + +<!-- =========== FIELD SUMMARY =========== --> + + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#ProxyMap(java.util.Map)">ProxyMap</A></B>(java.util.Map map)</CODE> + +<BR> + Creates a new instance acting as a representative for the + specified <code>Map</code>.</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#clear()">clear</A></B>()</CODE> + +<BR> + Invokes the underlying <CODE>Map.clear()</CODE> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#containsKey(java.lang.Object)">containsKey</A></B>(java.lang.Object key)</CODE> + +<BR> + Invokes the underlying <CODE>Map.containsKey(Object)</CODE> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#containsValue(java.lang.Object)">containsValue</A></B>(java.lang.Object value)</CODE> + +<BR> + Invokes the underlying <CODE>Map.containsValue(Object)</CODE> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Set</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#entrySet()">entrySet</A></B>()</CODE> + +<BR> + Invokes the underlying <CODE>Map.entrySet()</CODE> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object m)</CODE> + +<BR> + Invokes the underlying <CODE>Map.equals(Object)</CODE> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#get(java.lang.Object)">get</A></B>(java.lang.Object key)</CODE> + +<BR> + Invokes the underlying <CODE>Map.get(Object)</CODE> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#hashCode()">hashCode</A></B>()</CODE> + +<BR> + Invokes the underlying <CODE>Map.hashCode()</CODE> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#isEmpty()">isEmpty</A></B>()</CODE> + +<BR> + Invokes the underlying <CODE>Map.isEmpty()</CODE> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Set</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#keySet()">keySet</A></B>()</CODE> + +<BR> + Invokes the underlying <CODE>Map.keySet()</CODE> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#put(java.lang.Object, java.lang.Object)">put</A></B>(java.lang.Object key, + java.lang.Object value)</CODE> + +<BR> + Invokes the underlying <CODE>Map.put(Object,Object)</CODE> 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="../../../../org/apache/commons/collections/ProxyMap.html#putAll(java.util.Map)">putAll</A></B>(java.util.Map t)</CODE> + +<BR> + Invokes the underlying <CODE>Map.putAll(Map)</CODE> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#remove(java.lang.Object)">remove</A></B>(java.lang.Object key)</CODE> + +<BR> + Invokes the underlying <CODE>Map.remove(Object)</CODE> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#size()">size</A></B>()</CODE> + +<BR> + Invokes the underlying <CODE>Map.size()</CODE> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Collection</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ProxyMap.html#values()">values</A></B>()</CODE> + +<BR> + Invokes the underlying <CODE>Map.values()</CODE> method.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class java.lang.Object</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>getClass, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="ProxyMap(java.util.Map)"><!-- --></A><H3> +ProxyMap</H3> +<PRE> +public <B>ProxyMap</B>(java.util.Map map)</PRE> +<DL> +<DD>Creates a new instance acting as a representative for the + specified <code>Map</code>. +<P> +<DT><B>Parameters:</B><DD><CODE>map</CODE> - The <code>Map</code> to whose operations to wrap.</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="clear()"><!-- --></A><H3> +clear</H3> +<PRE> +public void <B>clear</B>()</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.clear()</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>clear</CODE> in interface <CODE>java.util.Map</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="containsKey(java.lang.Object)"><!-- --></A><H3> +containsKey</H3> +<PRE> +public boolean <B>containsKey</B>(java.lang.Object key)</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.containsKey(Object)</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>containsKey</CODE> in interface <CODE>java.util.Map</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="containsValue(java.lang.Object)"><!-- --></A><H3> +containsValue</H3> +<PRE> +public boolean <B>containsValue</B>(java.lang.Object value)</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.containsValue(Object)</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>containsValue</CODE> in interface <CODE>java.util.Map</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="entrySet()"><!-- --></A><H3> +entrySet</H3> +<PRE> +public java.util.Set <B>entrySet</B>()</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.entrySet()</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>entrySet</CODE> in interface <CODE>java.util.Map</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="equals(java.lang.Object)"><!-- --></A><H3> +equals</H3> +<PRE> +public boolean <B>equals</B>(java.lang.Object m)</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.equals(Object)</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>equals</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="get(java.lang.Object)"><!-- --></A><H3> +get</H3> +<PRE> +public java.lang.Object <B>get</B>(java.lang.Object key)</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.get(Object)</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>get</CODE> in interface <CODE>java.util.Map</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="hashCode()"><!-- --></A><H3> +hashCode</H3> +<PRE> +public int <B>hashCode</B>()</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.hashCode()</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>hashCode</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isEmpty()"><!-- --></A><H3> +isEmpty</H3> +<PRE> +public boolean <B>isEmpty</B>()</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.isEmpty()</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>isEmpty</CODE> in interface <CODE>java.util.Map</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="keySet()"><!-- --></A><H3> +keySet</H3> +<PRE> +public java.util.Set <B>keySet</B>()</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.keySet()</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>keySet</CODE> in interface <CODE>java.util.Map</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="put(java.lang.Object, java.lang.Object)"><!-- --></A><H3> +put</H3> +<PRE> +public java.lang.Object <B>put</B>(java.lang.Object key, + java.lang.Object value)</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.put(Object,Object)</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>put</CODE> in interface <CODE>java.util.Map</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="putAll(java.util.Map)"><!-- --></A><H3> +putAll</H3> +<PRE> +public void <B>putAll</B>(java.util.Map t)</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.putAll(Map)</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>putAll</CODE> in interface <CODE>java.util.Map</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="remove(java.lang.Object)"><!-- --></A><H3> +remove</H3> +<PRE> +public java.lang.Object <B>remove</B>(java.lang.Object key)</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.remove(Object)</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>remove</CODE> in interface <CODE>java.util.Map</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="size()"><!-- --></A><H3> +size</H3> +<PRE> +public int <B>size</B>()</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.size()</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>size</CODE> in interface <CODE>java.util.Map</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="values()"><!-- --></A><H3> +values</H3> +<PRE> +public java.util.Collection <B>values</B>()</PRE> +<DL> +<DD>Invokes the underlying <CODE>Map.values()</CODE> method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>values</CODE> in interface <CODE>java.util.Map</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + +<!-- ========== START OF NAVBAR ========== --> +<A NAME="navbar_bottom"><!-- --></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ProxyMap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/commons/collections/ProxyListIterator.html"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> + <A HREF="ProxyMap.html" TARGET="_top"><B>NO FRAMES</B></A> + +<SCRIPT> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> +<A HREF="../../../../allclasses-noframe.html" TARGET=""><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> +<!-- =========== END OF NAVBAR =========== --> + +<HR> +Copyright © 2001-2004 The Apache Software Foundation. All Rights Reserved. +</BODY> +</HTML>
Added: commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/ReferenceMap.html URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/ReferenceMap.html?rev=1422422&view=auto ============================================================================== --- commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/ReferenceMap.html (added) +++ commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/ReferenceMap.html Sat Dec 15 23:43:02 2012 @@ -0,0 +1,668 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc on Sat May 29 13:55:33 BST 2004 --> +<TITLE> +ReferenceMap (Collections 2.1.1 release API) +</TITLE> +<META NAME="keywords" CONTENT="org.apache.commons.collections.ReferenceMap,ReferenceMap class"> +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> +</HEAD> +<SCRIPT> +function asd() +{ +parent.document.title="ReferenceMap (Collections 2.1.1 release API)"; +} +</SCRIPT> +<BODY BGCOLOR="white" onload="asd();"> + +<!-- ========== START OF NAVBAR ========== --> +<A NAME="navbar_top"><!-- --></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReferenceMap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/commons/collections/ProxyMap.html"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/commons/collections/SequencedHashMap.html"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> + <A HREF="ReferenceMap.html" TARGET="_top"><B>NO FRAMES</B></A> + +<SCRIPT> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> +<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> +</NOSCRIPT> +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <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> +<!-- =========== END OF NAVBAR =========== --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.commons.collections</FONT> +<BR> +Class ReferenceMap</H2> +<PRE> +java.lang.Object + | + +--java.util.AbstractMap + | + +--<B>org.apache.commons.collections.ReferenceMap</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.util.Map</DD> +</DL> +<HR> +<DL> +<DT>public class <B>ReferenceMap</B><DT>extends java.util.AbstractMap</DL> + +<P> +Hashtable-based <CODE>Map</CODE> implementation that allows + mappings to be removed by the garbage collector.<P> + + When you construct a <Code>ReferenceMap</Code>, you can + specify what kind of references are used to store the + map's keys and values. If non-hard references are + used, then the garbage collector can remove mappings + if a key or value becomes unreachable, or if the + JVM's memory is running low. For information on how + the different reference types behave, see + <CODE>Reference</CODE>.<P> + + Different types of references can be specified for keys + and values. The keys can be configured to be weak but + the values hard, in which case this class will behave + like a <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/WeakHashMap.html";> + <Code>WeakHashMap</Code></A>. However, you + can also specify hard keys and weak values, or any other + combination. The default constructor uses hard keys + and soft values, providing a memory-sensitive cache.<P> + + The algorithms used are basically the same as those + in <CODE>HashMap</CODE>. In particular, you + can specify a load factor and capacity to suit your + needs. All optional <CODE>Map</CODE> operations are + supported.<P> + + However, this <CODE>Map</CODE> implementation does <I>not</I> + allow null elements. Attempting to add a null key or + or a null value to the map will raise a + <Code>NullPointerException</Code>.<P> + + As usual, this implementation is not synchronized. You + can use <CODE>Collections.synchronizedMap(java.util.Map)</CODE> to + provide synchronized access to a <Code>ReferenceMap</Code>. +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>2.1</DD> +<DT><B>Version:</B></DT> + <DD>$Id: ReferenceMap.java,v 1.7.2.1 2004/05/22 12:14:01 scolebourne Exp $</DD> +<DT><B>Author:</B></DT> + <DD>Paul Jack</DD> +<DT><B>See Also:</B><DD><CODE>Reference</CODE></DL> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + + +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Field Summary</B></FONT></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="../../../../org/apache/commons/collections/ReferenceMap.html#HARD">HARD</A></B></CODE> + +<BR> + Constant indicating that hard references should be used.</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="../../../../org/apache/commons/collections/ReferenceMap.html#SOFT">SOFT</A></B></CODE> + +<BR> + Constant indiciating that soft references should be used.</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="../../../../org/apache/commons/collections/ReferenceMap.html#WEAK">WEAK</A></B></CODE> + +<BR> + Constant indicating that weak references should be used.</TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#ReferenceMap()">ReferenceMap</A></B>()</CODE> + +<BR> + Constructs a new <Code>ReferenceMap</Code> that will + use hard references to keys and soft references to values.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#ReferenceMap(int, int)">ReferenceMap</A></B>(int keyType, + int valueType)</CODE> + +<BR> + Constructs a new <Code>ReferenceMap</Code> that will + use the specified types of references.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#ReferenceMap(int, int, int, float)">ReferenceMap</A></B>(int keyType, + int valueType, + int capacity, + float loadFactor)</CODE> + +<BR> + Constructs a new <Code>ReferenceMap</Code> with the + specified reference types, load factor and initial + capacity.</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#clear()">clear</A></B>()</CODE> + +<BR> + Clears this map.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#containsKey(java.lang.Object)">containsKey</A></B>(java.lang.Object key)</CODE> + +<BR> + Returns <Code>true</Code> if this map contains the given key.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Set</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#entrySet()">entrySet</A></B>()</CODE> + +<BR> + Returns a set view of this map's entries.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#get(java.lang.Object)">get</A></B>(java.lang.Object key)</CODE> + +<BR> + Returns the value associated with the given key, if any.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#isEmpty()">isEmpty</A></B>()</CODE> + +<BR> + Returns <Code>true</Code> if this map is empty.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Set</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#keySet()">keySet</A></B>()</CODE> + +<BR> + Returns a set view of this map's keys.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#put(java.lang.Object, java.lang.Object)">put</A></B>(java.lang.Object key, + java.lang.Object value)</CODE> + +<BR> + Associates the given key with the given value.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#remove(java.lang.Object)">remove</A></B>(java.lang.Object key)</CODE> + +<BR> + Removes the key and its associated value from this map.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#size()">size</A></B>()</CODE> + +<BR> + Returns the size of this map.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Collection</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#values()">values</A></B>()</CODE> + +<BR> + Returns a collection view of this map's values.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.util.AbstractMap"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class java.util.AbstractMap</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>containsValue, equals, hashCode, putAll, toString</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class java.lang.Object</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="HARD"><!-- --></A><H3> +HARD</H3> +<PRE> +public static final int <B>HARD</B></PRE> +<DL> +<DD>Constant indicating that hard references should be used. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.commons.collections.ReferenceMap.HARD">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="SOFT"><!-- --></A><H3> +SOFT</H3> +<PRE> +public static final int <B>SOFT</B></PRE> +<DL> +<DD>Constant indiciating that soft references should be used. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.commons.collections.ReferenceMap.SOFT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="WEAK"><!-- --></A><H3> +WEAK</H3> +<PRE> +public static final int <B>WEAK</B></PRE> +<DL> +<DD>Constant indicating that weak references should be used. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.commons.collections.ReferenceMap.WEAK">Constant Field Values</A></DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="ReferenceMap()"><!-- --></A><H3> +ReferenceMap</H3> +<PRE> +public <B>ReferenceMap</B>()</PRE> +<DL> +<DD>Constructs a new <Code>ReferenceMap</Code> that will + use hard references to keys and soft references to values. +<P> +</DL> +<HR> + +<A NAME="ReferenceMap(int, int)"><!-- --></A><H3> +ReferenceMap</H3> +<PRE> +public <B>ReferenceMap</B>(int keyType, + int valueType)</PRE> +<DL> +<DD>Constructs a new <Code>ReferenceMap</Code> that will + use the specified types of references. +<P> +<DT><B>Parameters:</B><DD><CODE>keyType</CODE> - the type of reference to use for keys; + must be <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#HARD"><CODE>HARD</CODE></A>, <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#SOFT"><CODE>SOFT</CODE></A>, <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#WEAK"><CODE>WEAK</CODE></A><DD><CODE>valueType</CODE> - the type of reference to use for values; + must be <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#HARD"><CODE>HARD</CODE></A>, <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#SOFT"><CODE>SOFT</CODE></A>, <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#WEAK"><CODE>WEAK</CODE></A></DL> +<HR> + +<A NAME="ReferenceMap(int, int, int, float)"><!-- --></A><H3> +ReferenceMap</H3> +<PRE> +public <B>ReferenceMap</B>(int keyType, + int valueType, + int capacity, + float loadFactor)</PRE> +<DL> +<DD>Constructs a new <Code>ReferenceMap</Code> with the + specified reference types, load factor and initial + capacity. +<P> +<DT><B>Parameters:</B><DD><CODE>keyType</CODE> - the type of reference to use for keys; + must be <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#HARD"><CODE>HARD</CODE></A>, <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#SOFT"><CODE>SOFT</CODE></A>, <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#WEAK"><CODE>WEAK</CODE></A><DD><CODE>valueType</CODE> - the type of reference to use for values; + must be <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#HARD"><CODE>HARD</CODE></A>, <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#SOFT"><CODE>SOFT</CODE></A>, <A HREF="../../../../org/apache/commons/collections/ReferenceMap.html#WEAK"><CODE>WEAK</CODE></A><DD><CODE>capacity</CODE> - the initial capacity for the map<DD><CODE>loadFactor</CODE> - the load factor for the map</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="size()"><!-- --></A><H3> +size</H3> +<PRE> +public int <B>size</B>()</PRE> +<DL> +<DD>Returns the size of this map. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>size</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>size</CODE> in class <CODE>java.util.AbstractMap</CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the size of this map</DL> +</DD> +</DL> +<HR> + +<A NAME="isEmpty()"><!-- --></A><H3> +isEmpty</H3> +<PRE> +public boolean <B>isEmpty</B>()</PRE> +<DL> +<DD>Returns <Code>true</Code> if this map is empty. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>isEmpty</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>isEmpty</CODE> in class <CODE>java.util.AbstractMap</CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD><Code>true</Code> if this map is empty</DL> +</DD> +</DL> +<HR> + +<A NAME="containsKey(java.lang.Object)"><!-- --></A><H3> +containsKey</H3> +<PRE> +public boolean <B>containsKey</B>(java.lang.Object key)</PRE> +<DL> +<DD>Returns <Code>true</Code> if this map contains the given key. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>containsKey</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>containsKey</CODE> in class <CODE>java.util.AbstractMap</CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>true if the given key is in this map</DL> +</DD> +</DL> +<HR> + +<A NAME="get(java.lang.Object)"><!-- --></A><H3> +get</H3> +<PRE> +public java.lang.Object <B>get</B>(java.lang.Object key)</PRE> +<DL> +<DD>Returns the value associated with the given key, if any. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>get</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>get</CODE> in class <CODE>java.util.AbstractMap</CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the value associated with the given key, or <Code>null</Code> + if the key maps to no value</DL> +</DD> +</DL> +<HR> + +<A NAME="put(java.lang.Object, java.lang.Object)"><!-- --></A><H3> +put</H3> +<PRE> +public java.lang.Object <B>put</B>(java.lang.Object key, + java.lang.Object value)</PRE> +<DL> +<DD>Associates the given key with the given value.<P> + Neither the key nor the value may be null. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>put</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>put</CODE> in class <CODE>java.util.AbstractMap</CODE></DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key of the mapping<DD><CODE>value</CODE> - the value of the mapping +<DT><B>Returns:</B><DD>the last value associated with that key, or + null if no value was associated with the key +<DT><B>Throws:</B> +<DD><CODE>java.lang.NullPointerException</CODE> - if either the key or value + is null</DL> +</DD> +</DL> +<HR> + +<A NAME="remove(java.lang.Object)"><!-- --></A><H3> +remove</H3> +<PRE> +public java.lang.Object <B>remove</B>(java.lang.Object key)</PRE> +<DL> +<DD>Removes the key and its associated value from this map. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>remove</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>remove</CODE> in class <CODE>java.util.AbstractMap</CODE></DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key to remove +<DT><B>Returns:</B><DD>the value associated with that key, or null if + the key was not in the map</DL> +</DD> +</DL> +<HR> + +<A NAME="clear()"><!-- --></A><H3> +clear</H3> +<PRE> +public void <B>clear</B>()</PRE> +<DL> +<DD>Clears this map. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>clear</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>clear</CODE> in class <CODE>java.util.AbstractMap</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="entrySet()"><!-- --></A><H3> +entrySet</H3> +<PRE> +public java.util.Set <B>entrySet</B>()</PRE> +<DL> +<DD>Returns a set view of this map's entries. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>entrySet</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Specified by:</B><DD><CODE>entrySet</CODE> in class <CODE>java.util.AbstractMap</CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>a set view of this map's entries</DL> +</DD> +</DL> +<HR> + +<A NAME="keySet()"><!-- --></A><H3> +keySet</H3> +<PRE> +public java.util.Set <B>keySet</B>()</PRE> +<DL> +<DD>Returns a set view of this map's keys. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>keySet</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>keySet</CODE> in class <CODE>java.util.AbstractMap</CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>a set view of this map's keys</DL> +</DD> +</DL> +<HR> + +<A NAME="values()"><!-- --></A><H3> +values</H3> +<PRE> +public java.util.Collection <B>values</B>()</PRE> +<DL> +<DD>Returns a collection view of this map's values. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>values</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>values</CODE> in class <CODE>java.util.AbstractMap</CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>a collection view of this map's values.</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + +<!-- ========== START OF NAVBAR ========== --> +<A NAME="navbar_bottom"><!-- --></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReferenceMap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/commons/collections/ProxyMap.html"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/commons/collections/SequencedHashMap.html"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> + <A HREF="ReferenceMap.html" TARGET="_top"><B>NO FRAMES</B></A> + +<SCRIPT> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> +<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> +</NOSCRIPT> +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <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> +<!-- =========== END OF NAVBAR =========== --> + +<HR> +Copyright © 2001-2004 The Apache Software Foundation. All Rights Reserved. +</BODY> +</HTML>
