KezvhLib/lib/org.apache.commons.collections/apidocs/org/apache/commons/collections/BoundedMap.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.5.0_07) on Fri Apr 11 15:39:16 BST 2008 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   7 <TITLE>
   8 BoundedMap (Commons Collections 3.2.1 API)
   9 </TITLE>
  10
  11 <META NAME="keywords" CONTENT="org.apache.commons.collections.BoundedMap interface">
  12
  13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
  14
  15 <SCRIPT type="text/javascript">
  16 function windowTitle()
  17 {
  18     parent.document.title="BoundedMap (Commons Collections 3.2.1 API)";
  19 }
  20 </SCRIPT>
  21 <NOSCRIPT>
  22 </NOSCRIPT>
  23
  24 </HEAD>
  25
  26 <BODY BGCOLOR="white" onload="windowTitle();">
  27
  28
  29 <!-- ========= START OF TOP NAVBAR ======= -->
  30 <A NAME="navbar_top"><!-- --></A>
  31 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  32 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  33 <TR>
  34 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  35 <A NAME="navbar_top_firstrow"><!-- --></A>
  36 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  37   <TR ALIGN="center" VALIGN="top">
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  40   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BoundedMap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  46   </TR>
  47 </TABLE>
  48 </TD>
  49 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  50 </EM>
  51 </TD>
  52 </TR>
  53
  54 <TR>
  55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  56 &nbsp;<A HREF="../../../../org/apache/commons/collections/BoundedFifoBuffer.html" title="class in org.apache.commons.collections"><B>PREV CLASS</B></A>&nbsp;
  57 &nbsp;<A HREF="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections"><B>NEXT CLASS</B></A></FONT></TD>
  58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  59   <A HREF="../../../../index.html?org/apache/commons/collections/BoundedMap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  60 &nbsp;<A HREF="BoundedMap.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  61 &nbsp;<SCRIPT type="text/javascript">
  62   <!--
  63   if(window==top) {
  64     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  65   }
  66   //-->
  67 </SCRIPT>
  68 <NOSCRIPT>
  69   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  70 </NOSCRIPT>
  71
  72
  73 </FONT></TD>
  74 </TR>
  75 <TR>
  76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  77   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  79 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  80 </TR>
  81 </TABLE>
  82 <A NAME="skip-navbar_top"></A>
  83 <!-- ========= END OF TOP NAVBAR ========= -->
  84
  85 <HR>
  86 <!-- ======== START OF CLASS DATA ======== -->
  87 <H2>
  88 <FONT SIZE="-1">
  89 org.apache.commons.collections</FONT>
  90 <BR>
  91 Interface BoundedMap</H2>
  92 <DL>
  93 <DT><B>All Superinterfaces:</B> <DD>java.util.Map</DD>
  94 </DL>
  95 <DL>
  96 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/commons/collections/map/FixedSizeMap.html" title="class in org.apache.commons.collections.map">FixedSizeMap</A>, <A HREF="../../../../org/apache/commons/collections/map/FixedSizeSortedMap.html" title="class in org.apache.commons.collections.map">FixedSizeSortedMap</A>, <A HREF="../../../../org/apache/commons/collections/map/LRUMap.html" title="class in org.apache.commons.collections.map">LRUMap</A>, <A HREF="../../../../org/apache/commons/collections/map/SingletonMap.html" title="class in org.apache.commons.collections.map">SingletonMap</A></DD>
  97 </DL>
  98 <HR>
  99 <DL>
 100 <DT><PRE>public interface <B>BoundedMap</B><DT>extends java.util.Map</DL>
 101 </PRE>
 102
 103 <P>
 104 Defines a map that is bounded in size.
 105  <p>
 106  The size of the map can vary, but it can never exceed a preset
 107  maximum number of elements. This interface allows the querying of details
 108  associated with the maximum number of elements.
 109 <P>
 110
 111 <P>
 112 <DL>
 113 <DT><B>Since:</B></DT>
 114   <DD>Commons Collections 3.0</DD>
 115 <DT><B>Version:</B></DT>
 116   <DD>$Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $</DD>
 117 <DT><B>Author:</B></DT>
 118   <DD>Stephen Colebourne</DD>
 119 </DL>
 120 <HR>
 121
 122 <P>
 123 <!-- ======== NESTED CLASS SUMMARY ======== -->
 124
 125 <A NAME="nested_class_summary"><!-- --></A>
 126 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 127 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 128 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 129 <B>Nested Class Summary</B></FONT></TH>
 130 </TR>
 131 </TABLE>
 132 &nbsp;<A NAME="nested_classes_inherited_from_class_java.util.Map"><!-- --></A>
 133 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 134 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 135 <TH ALIGN="left"><B>Nested classes/interfaces inherited from interface java.util.Map</B></TH>
 136 </TR>
 137 <TR BGCOLOR="white" CLASS="TableRowColor">
 138 <TD><CODE>java.util.Map.Entry</CODE></TD>
 139 </TR>
 140 </TABLE>
 141 &nbsp;
 142
 143 <!-- ========== METHOD SUMMARY =========== -->
 144
 145 <A NAME="method_summary"><!-- --></A>
 146 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 147 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 148 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 149 <B>Method Summary</B></FONT></TH>
 150 </TR>
 151 <TR BGCOLOR="white" CLASS="TableRowColor">
 152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 153 <CODE>&nbsp;boolean</CODE></FONT></TD>
 154 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BoundedMap.html#isFull()">isFull</A></B>()</CODE>
 155
 156 <BR>
 157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if this map is full and no new elements can be added.</TD>
 158 </TR>
 159 <TR BGCOLOR="white" CLASS="TableRowColor">
 160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 161 <CODE>&nbsp;int</CODE></FONT></TD>
 162 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BoundedMap.html#maxSize()">maxSize</A></B>()</CODE>
 163
 164 <BR>
 165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the maximum size of the map (the bound).</TD>
 166 </TR>
 167 </TABLE>
 168 &nbsp;<A NAME="methods_inherited_from_class_java.util.Map"><!-- --></A>
 169 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 170 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 171 <TH ALIGN="left"><B>Methods inherited from interface java.util.Map</B></TH>
 172 </TR>
 173 <TR BGCOLOR="white" CLASS="TableRowColor">
 174 <TD><CODE>clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values</CODE></TD>
 175 </TR>
 176 </TABLE>
 177 &nbsp;
 178 <P>
 179
 180 <!-- ============ METHOD DETAIL ========== -->
 181
 182 <A NAME="method_detail"><!-- --></A>
 183 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 184 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 185 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 186 <B>Method Detail</B></FONT></TH>
 187 </TR>
 188 </TABLE>
 189
 190 <A NAME="isFull()"><!-- --></A><H3>
 191 isFull</H3>
 192 <PRE>
 193 boolean <B>isFull</B>()</PRE>
 194 <DL>
 195 <DD>Returns true if this map is full and no new elements can be added.
 196 <P>
 197 <DD><DL>
 198 </DL>
 199 </DD>
 200 <DD><DL>
 201
 202 <DT><B>Returns:</B><DD><code>true</code> if the map is full</DL>
 203 </DD>
 204 </DL>
 205 <HR>
 206
 207 <A NAME="maxSize()"><!-- --></A><H3>
 208 maxSize</H3>
 209 <PRE>
 210 int <B>maxSize</B>()</PRE>
 211 <DL>
 212 <DD>Gets the maximum size of the map (the bound).
 213 <P>
 214 <DD><DL>
 215 </DL>
 216 </DD>
 217 <DD><DL>
 218
 219 <DT><B>Returns:</B><DD>the maximum number of elements the map can hold</DL>
 220 </DD>
 221 </DL>
 222 <!-- ========= END OF CLASS DATA ========= -->
 223 <HR>
 224
 225
 226 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 227 <A NAME="navbar_bottom"><!-- --></A>
 228 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 229 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 230 <TR>
 231 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 232 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 233 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 234   <TR ALIGN="center" VALIGN="top">
 235   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 236   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 237   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 238   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BoundedMap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 239   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 240   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 241   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 242   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 243   </TR>
 244 </TABLE>
 245 </TD>
 246 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 247 </EM>
 248 </TD>
 249 </TR>
 250
 251 <TR>
 252 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 253 &nbsp;<A HREF="../../../../org/apache/commons/collections/BoundedFifoBuffer.html" title="class in org.apache.commons.collections"><B>PREV CLASS</B></A>&nbsp;
 254 &nbsp;<A HREF="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections"><B>NEXT CLASS</B></A></FONT></TD>
 255 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 256   <A HREF="../../../../index.html?org/apache/commons/collections/BoundedMap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 257 &nbsp;<A HREF="BoundedMap.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 258 &nbsp;<SCRIPT type="text/javascript">
 259   <!--
 260   if(window==top) {
 261     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 262   }
 263   //-->
 264 </SCRIPT>
 265 <NOSCRIPT>
 266   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 267 </NOSCRIPT>
 268
 269
 270 </FONT></TD>
 271 </TR>
 272 <TR>
 273 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 274   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 275 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 276 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 277 </TR>
 278 </TABLE>
 279 <A NAME="skip-navbar_bottom"></A>
 280 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 281
 282 <HR>
 283 Copyright © 2001-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
 284 </BODY>
 285 </HTML>