mirror of
https://github.com/ChronosX88/FreePastry.git
synced 2025-01-16 01:26:27 +00:00
829 lines
31 KiB
HTML
829 lines
31 KiB
HTML
<!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_07) on Fri Mar 13 20:01:31 CET 2009 -->
|
|
<TITLE>
|
|
ImmutableSortedMap (Rice Pastry - API Specifications)
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2009-03-13">
|
|
|
|
<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="ImmutableSortedMap (Rice Pastry - API Specifications)";
|
|
}
|
|
}
|
|
</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="class-use/ImmutableSortedMap.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>
|
|
Rice Pastry API</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../rice/p2p/util/IdBloomFilter.html" title="class in rice.p2p.util"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../rice/p2p/util/MathUtils.html" title="class in rice.p2p.util"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../index.html?rice/p2p/util/ImmutableSortedMap.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="ImmutableSortedMap.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 | <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>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
rice.p2p.util</FONT>
|
|
<BR>
|
|
Class ImmutableSortedMap</H2>
|
|
<PRE>
|
|
java.lang.Object
|
|
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>rice.p2p.util.ImmutableSortedMap</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.util.Map, java.util.SortedMap</DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public class <B>ImmutableSortedMap</B><DT>extends java.lang.Object<DT>implements java.util.SortedMap, java.io.Serializable</DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Version:</B></DT>
|
|
<DD>$Id: ImmutableSortedMap.java 4654 2009-01-08 16:33:07Z jeffh $</DD>
|
|
<DT><B>Author:</B></DT>
|
|
<DD>Alan Mislove</DD>
|
|
<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#rice.p2p.util.ImmutableSortedMap">Serialized Form</A></DL>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
|
<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="nested_classes_inherited_from_class_java.util.Map"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface java.util.Map</B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE>java.util.Map.Entry<K,V></CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_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>Field Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected java.util.SortedMap</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/util/ImmutableSortedMap.html#map">map</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ======== 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="../../../rice/p2p/util/ImmutableSortedMap.html#ImmutableSortedMap(java.util.SortedMap)">ImmutableSortedMap</A></B>(java.util.SortedMap map)</CODE>
|
|
|
|
<BR>
|
|
Constructor which takes an existing map</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> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/util/ImmutableSortedMap.html#clear()">clear</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Removes all mappings from this map (optional operation).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.Comparator</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/util/ImmutableSortedMap.html#comparator()">comparator</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the comparator associated with this sorted map, or
|
|
<tt>null</tt> if it uses its keys' natural ordering.</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="../../../rice/p2p/util/ImmutableSortedMap.html#containsKey(java.lang.Object)">containsKey</A></B>(java.lang.Object key)</CODE>
|
|
|
|
<BR>
|
|
Returns <tt>true</tt> if this map contains a mapping for the specified
|
|
key.</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="../../../rice/p2p/util/ImmutableSortedMap.html#containsValue(java.lang.Object)">containsValue</A></B>(java.lang.Object value)</CODE>
|
|
|
|
<BR>
|
|
Returns <tt>true</tt> if this map maps one or more keys to the
|
|
specified value.</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="../../../rice/p2p/util/ImmutableSortedMap.html#entrySet()">entrySet</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns a set view of the mappings contained in this map.</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="../../../rice/p2p/util/ImmutableSortedMap.html#firstKey()">firstKey</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the first (lowest) key currently in this sorted map.</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="../../../rice/p2p/util/ImmutableSortedMap.html#get(java.lang.Object)">get</A></B>(java.lang.Object key)</CODE>
|
|
|
|
<BR>
|
|
Returns the value to which this map maps the specified key.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.SortedMap</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/util/ImmutableSortedMap.html#headMap(java.lang.Object)">headMap</A></B>(java.lang.Object toKey)</CODE>
|
|
|
|
<BR>
|
|
Returns a view of the portion of this sorted map whose keys are
|
|
strictly less than toKey.</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="../../../rice/p2p/util/ImmutableSortedMap.html#isEmpty()">isEmpty</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns <tt>true</tt> if this map contains no key-value mappings.</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="../../../rice/p2p/util/ImmutableSortedMap.html#keySet()">keySet</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns a set view of the keys contained in this map.</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="../../../rice/p2p/util/ImmutableSortedMap.html#lastKey()">lastKey</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the last (highest) key currently in this sorted map.</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="../../../rice/p2p/util/ImmutableSortedMap.html#put(java.lang.Object, java.lang.Object)">put</A></B>(java.lang.Object key,
|
|
java.lang.Object value)</CODE>
|
|
|
|
<BR>
|
|
Associates the specified value with the specified key in this map
|
|
(optional operation).</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="../../../rice/p2p/util/ImmutableSortedMap.html#putAll(java.util.Map)">putAll</A></B>(java.util.Map t)</CODE>
|
|
|
|
<BR>
|
|
Copies all of the mappings from the specified map to this map
|
|
(optional operation).</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="../../../rice/p2p/util/ImmutableSortedMap.html#remove(java.lang.Object)">remove</A></B>(java.lang.Object key)</CODE>
|
|
|
|
<BR>
|
|
Removes the mapping for this key from this map if it is present
|
|
(optional operation).</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="../../../rice/p2p/util/ImmutableSortedMap.html#size()">size</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the number of key-value mappings in this map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.SortedMap</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/util/ImmutableSortedMap.html#subMap(java.lang.Object, java.lang.Object)">subMap</A></B>(java.lang.Object fromKey,
|
|
java.lang.Object toKey)</CODE>
|
|
|
|
<BR>
|
|
Returns a view of the portion of this sorted map whose keys range from
|
|
<tt>fromKey</tt>, inclusive, to <tt>toKey</tt>, exclusive.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.SortedMap</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/util/ImmutableSortedMap.html#tailMap(java.lang.Object)">tailMap</A></B>(java.lang.Object fromKey)</CODE>
|
|
|
|
<BR>
|
|
Returns a view of the portion of this sorted map whose keys are greater
|
|
than or equal to <tt>fromKey</tt>.</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="../../../rice/p2p/util/ImmutableSortedMap.html#values()">values</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns a collection view of the values contained in this map.</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>
|
|
<A NAME="methods_inherited_from_class_java.util.Map"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Methods inherited from interface java.util.Map</B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE>equals, hashCode</CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
|
|
<A NAME="field_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>Field Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="map"><!-- --></A><H3>
|
|
map</H3>
|
|
<PRE>
|
|
protected java.util.SortedMap <B>map</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
|
|
<!-- ========= 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="ImmutableSortedMap(java.util.SortedMap)"><!-- --></A><H3>
|
|
ImmutableSortedMap</H3>
|
|
<PRE>
|
|
public <B>ImmutableSortedMap</B>(java.util.SortedMap map)</PRE>
|
|
<DL>
|
|
<DD>Constructor which takes an existing map
|
|
<P>
|
|
<DL>
|
|
<DT><B>Parameters:</B><DD><CODE>map</CODE> - the existing map</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="comparator()"><!-- --></A><H3>
|
|
comparator</H3>
|
|
<PRE>
|
|
public java.util.Comparator <B>comparator</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the comparator associated with this sorted map, or
|
|
<tt>null</tt> if it uses its keys' natural ordering.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>comparator</CODE> in interface <CODE>java.util.SortedMap</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the comparator associated with this sorted map, or
|
|
<tt>null</tt> if it uses its keys' natural ordering.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="subMap(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
|
|
subMap</H3>
|
|
<PRE>
|
|
public java.util.SortedMap <B>subMap</B>(java.lang.Object fromKey,
|
|
java.lang.Object toKey)</PRE>
|
|
<DL>
|
|
<DD>Returns a view of the portion of this sorted map whose keys range from
|
|
<tt>fromKey</tt>, inclusive, to <tt>toKey</tt>, exclusive.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>subMap</CODE> in interface <CODE>java.util.SortedMap</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>fromKey</CODE> - low endpoint (inclusive) of the subMap.<DD><CODE>toKey</CODE> - high endpoint (exclusive) of the subMap.
|
|
<DT><B>Returns:</B><DD>a view of the specified range within this sorted map.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="headMap(java.lang.Object)"><!-- --></A><H3>
|
|
headMap</H3>
|
|
<PRE>
|
|
public java.util.SortedMap <B>headMap</B>(java.lang.Object toKey)</PRE>
|
|
<DL>
|
|
<DD>Returns a view of the portion of this sorted map whose keys are
|
|
strictly less than toKey.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>headMap</CODE> in interface <CODE>java.util.SortedMap</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>toKey</CODE> - high endpoint (exclusive) of the subMap.
|
|
<DT><B>Returns:</B><DD>a view of the specified initial range of this sorted map.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="tailMap(java.lang.Object)"><!-- --></A><H3>
|
|
tailMap</H3>
|
|
<PRE>
|
|
public java.util.SortedMap <B>tailMap</B>(java.lang.Object fromKey)</PRE>
|
|
<DL>
|
|
<DD>Returns a view of the portion of this sorted map whose keys are greater
|
|
than or equal to <tt>fromKey</tt>.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>tailMap</CODE> in interface <CODE>java.util.SortedMap</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>fromKey</CODE> - low endpoint (inclusive) of the tailMap.
|
|
<DT><B>Returns:</B><DD>a view of the specified final range of this sorted map.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="firstKey()"><!-- --></A><H3>
|
|
firstKey</H3>
|
|
<PRE>
|
|
public java.lang.Object <B>firstKey</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the first (lowest) key currently in this sorted map.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>firstKey</CODE> in interface <CODE>java.util.SortedMap</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the first (lowest) key currently in this sorted map.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.util.NoSuchElementException</CODE> - if this map is empty.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="lastKey()"><!-- --></A><H3>
|
|
lastKey</H3>
|
|
<PRE>
|
|
public java.lang.Object <B>lastKey</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the last (highest) key currently in this sorted map.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>lastKey</CODE> in interface <CODE>java.util.SortedMap</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the last (highest) key currently in this sorted map.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.util.NoSuchElementException</CODE> - if this map is empty.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="size()"><!-- --></A><H3>
|
|
size</H3>
|
|
<PRE>
|
|
public int <B>size</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the number of key-value mappings in this map. If the
|
|
map contains more than <tt>Integer.MAX_VALUE</tt> elements, returns
|
|
<tt>Integer.MAX_VALUE</tt>.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>size</CODE> in interface <CODE>java.util.Map</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the number of key-value mappings in this map.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="isEmpty()"><!-- --></A><H3>
|
|
isEmpty</H3>
|
|
<PRE>
|
|
public boolean <B>isEmpty</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns <tt>true</tt> if this map contains no key-value mappings.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>isEmpty</CODE> in interface <CODE>java.util.Map</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD><tt>true</tt> if this map contains no key-value mappings.</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 <tt>true</tt> if this map contains a mapping for the specified
|
|
key.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>containsKey</CODE> in interface <CODE>java.util.Map</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>key</CODE> - key whose presence in this map is to be tested.
|
|
<DT><B>Returns:</B><DD><tt>true</tt> if this map contains a mapping for the specified</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>Returns <tt>true</tt> if this map maps one or more keys to the
|
|
specified value.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>containsValue</CODE> in interface <CODE>java.util.Map</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - value whose presence in this map is to be tested.
|
|
<DT><B>Returns:</B><DD><tt>true</tt> if this map maps one or more keys to the
|
|
specified value.</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 to which this map maps the specified key. Returns
|
|
<tt>null</tt> if the map contains no mapping for this key.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>get</CODE> in interface <CODE>java.util.Map</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>key</CODE> - key whose associated value is to be returned.
|
|
<DT><B>Returns:</B><DD>the value to which this map maps the specified key, or
|
|
<tt>null</tt> if the map contains no mapping for this key.</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 specified value with the specified key in this map
|
|
(optional operation). If the map previously contained a mapping for
|
|
this key, the old value is replaced by the specified value.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>put</CODE> in interface <CODE>java.util.Map</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>key</CODE> - key with which the specified value is to be associated.<DD><CODE>value</CODE> - value to be associated with the specified key.
|
|
<DT><B>Returns:</B><DD>previous value associated with specified key, or <tt>null</tt>
|
|
if there was no mapping for key. A <tt>null</tt> return can
|
|
also indicate that the map previously associated <tt>null</tt>
|
|
with the specified key, if the implementation supports
|
|
<tt>null</tt> values.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if the <tt>put</tt> operation is
|
|
not supported by this map.</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 mapping for this key from this map if it is present
|
|
(optional operation). More formally, if this map contains a mapping
|
|
from key <tt>k</tt> to value <tt>v</tt> such that
|
|
<code>(key==null ? k==null : key.equals(k))</code>, that mapping
|
|
is removed.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>remove</CODE> in interface <CODE>java.util.Map</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>key</CODE> - key whose mapping is to be removed from the map.
|
|
<DT><B>Returns:</B><DD>previous value associated with specified key, or <tt>null</tt>
|
|
if there was no mapping for key.</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>Copies all of the mappings from the specified map to this map
|
|
(optional operation).
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>putAll</CODE> in interface <CODE>java.util.Map</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>t</CODE> - Mappings to be stored in this map.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="clear()"><!-- --></A><H3>
|
|
clear</H3>
|
|
<PRE>
|
|
public void <B>clear</B>()</PRE>
|
|
<DL>
|
|
<DD>Removes all mappings from this map (optional operation).
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>clear</CODE> in interface <CODE>java.util.Map</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - clear is not supported by this
|
|
map.</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 the keys contained in this map. The set is
|
|
backed by the map, so changes to the map are reflected in the set, and
|
|
vice-versa. If the map is modified while an iteration over the set is
|
|
in progress, the results of the iteration are undefined. The set
|
|
supports element removal, which removes the corresponding mapping from
|
|
the map, via the <tt>Iterator.remove</tt>, <tt>Set.remove</tt>,
|
|
<tt>removeAll</tt> <tt>retainAll</tt>, and <tt>clear</tt> operations.
|
|
It does not support the add or <tt>addAll</tt> operations.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>keySet</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Specified by:</B><DD><CODE>keySet</CODE> in interface <CODE>java.util.SortedMap</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a set view of the keys contained in this map.</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 the values contained in this map. The
|
|
collection is backed by the map, so changes to the map are reflected in
|
|
the collection, and vice-versa. If the map is modified while an
|
|
iteration over the collection is in progress, the results of the
|
|
iteration are undefined. The collection supports element removal,
|
|
which removes the corresponding mapping from the map, via the
|
|
<tt>Iterator.remove</tt>, <tt>Collection.remove</tt>,
|
|
<tt>removeAll</tt>, <tt>retainAll</tt> and <tt>clear</tt> operations.
|
|
It does not support the add or <tt>addAll</tt> operations.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>values</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Specified by:</B><DD><CODE>values</CODE> in interface <CODE>java.util.SortedMap</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a collection view of the values contained in this map.</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 the mappings contained in this map. Each element
|
|
in the returned set is a <CODE>Map.Entry</CODE>. The set is backed by the
|
|
map, so changes to the map are reflected in the set, and vice-versa.
|
|
If the map is modified while an iteration over the set is in progress,
|
|
the results of the iteration are undefined. The set supports element
|
|
removal, which removes the corresponding mapping from the map, via the
|
|
<tt>Iterator.remove</tt>, <tt>Set.remove</tt>, <tt>removeAll</tt>,
|
|
<tt>retainAll</tt> and <tt>clear</tt> operations. It does not support
|
|
the <tt>add</tt> or <tt>addAll</tt> operations.
|
|
<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 interface <CODE>java.util.SortedMap</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a set view of the mappings contained in this map.</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="class-use/ImmutableSortedMap.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>
|
|
Rice Pastry API</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../rice/p2p/util/IdBloomFilter.html" title="class in rice.p2p.util"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../rice/p2p/util/MathUtils.html" title="class in rice.p2p.util"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../index.html?rice/p2p/util/ImmutableSortedMap.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="ImmutableSortedMap.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 | <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>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
<i>Copyright © 2001-2005 - Rice Pastry.</i>
|
|
</BODY>
|
|
</HTML>
|