1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (build 1.5.0_07) on Fri Apr 11 15:39:22 BST 2008 -->
6 <META http-equiv=
"Content-Type" content=
"text/html; charset=ISO-8859-1">
8 TransformedSortedMap (Commons Collections
3.2.1 API)
11 <META NAME=
"keywords" CONTENT=
"org.apache.commons.collections.map.TransformedSortedMap class">
13 <LINK REL =
"stylesheet" TYPE=
"text/css" HREF=
"../../../../../stylesheet.css" TITLE=
"Style">
15 <SCRIPT type=
"text/javascript">
16 function windowTitle()
18 parent.document.
title=
"TransformedSortedMap (Commons Collections 3.2.1 API)";
26 <BODY BGCOLOR=
"white" onload=
"windowTitle();">
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=
"">
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> </TD>
39 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"package-summary.html"><FONT CLASS=
"NavBarFont1"><B>Package
</B></FONT></A> </TD>
40 <TD BGCOLOR=
"#FFFFFF" CLASS=
"NavBarCell1Rev"> <FONT CLASS=
"NavBarFont1Rev"><B>Class
</B></FONT> </TD>
41 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"class-use/TransformedSortedMap.html"><FONT CLASS=
"NavBarFont1"><B>Use
</B></FONT></A> </TD>
42 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"package-tree.html"><FONT CLASS=
"NavBarFont1"><B>Tree
</B></FONT></A> </TD>
43 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../../../deprecated-list.html"><FONT CLASS=
"NavBarFont1"><B>Deprecated
</B></FONT></A> </TD>
44 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../../../index-all.html"><FONT CLASS=
"NavBarFont1"><B>Index
</B></FONT></A> </TD>
45 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../../../help-doc.html"><FONT CLASS=
"NavBarFont1"><B>Help
</B></FONT></A> </TD>
49 <TD ALIGN=
"right" VALIGN=
"top" ROWSPAN=
3><EM>
55 <TD BGCOLOR=
"white" CLASS=
"NavBarCell2"><FONT SIZE=
"-2">
56 <A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html" title=
"class in org.apache.commons.collections.map"><B>PREV CLASS
</B></A>
57 <A HREF=
"../../../../../org/apache/commons/collections/map/TypedMap.html" title=
"class in org.apache.commons.collections.map"><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/map/TransformedSortedMap.html" target=
"_top"><B>FRAMES
</B></A>
60 <A HREF=
"TransformedSortedMap.html" target=
"_top"><B>NO FRAMES
</B></A>
61 <SCRIPT type=
"text/javascript">
64 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
69 <A HREF=
"../../../../../allclasses-noframe.html"><B>All Classes
</B></A>
76 <TD VALIGN=
"top" CLASS=
"NavBarCell3"><FONT SIZE=
"-2">
77 SUMMARY:
NESTED
|
<A HREF=
"#fields_inherited_from_class_org.apache.commons.collections.map.TransformedMap">FIELD
</A> |
<A HREF=
"#constructor_summary">CONSTR
</A> |
<A HREF=
"#method_summary">METHOD
</A></FONT></TD>
78 <TD VALIGN=
"top" CLASS=
"NavBarCell3"><FONT SIZE=
"-2">
79 DETAIL:
FIELD
|
<A HREF=
"#constructor_detail">CONSTR
</A> |
<A HREF=
"#method_detail">METHOD
</A></FONT></TD>
82 <A NAME=
"skip-navbar_top"></A>
83 <!-- ========= END OF TOP NAVBAR ========= -->
86 <!-- ======== START OF CLASS DATA ======== -->
89 org.apache.commons.collections.map
</FONT>
91 Class TransformedSortedMap
</H2>
94 <IMG SRC=
"../../../../../resources/inherit.gif" ALT=
"extended by "><A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html" title=
"class in org.apache.commons.collections.map">org.apache.commons.collections.map.AbstractMapDecorator
</A>
95 <IMG SRC=
"../../../../../resources/inherit.gif" ALT=
"extended by "><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html" title=
"class in org.apache.commons.collections.map">org.apache.commons.collections.map.TransformedMap
</A>
96 <IMG SRC=
"../../../../../resources/inherit.gif" ALT=
"extended by "><B>org.apache.commons.collections.map.TransformedSortedMap
</B>
99 <DT><B>All Implemented Interfaces:
</B> <DD>java.io.Serializable, java.util.Map, java.util.SortedMap
</DD>
103 <DT><PRE>public class
<B>TransformedSortedMap
</B><DT>extends
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html" title=
"class in org.apache.commons.collections.map">TransformedMap
</A><DT>implements java.util.SortedMap
</DL>
107 Decorates another
<code>SortedMap
</code> to transform objects that are added.
109 The Map put methods and Map.Entry setValue method are affected by this class.
110 Thus objects must be removed or searched for using their transformed form.
111 For example, if the transformation converts Strings to Integers, you must
112 use the Integer form to remove objects.
114 <strong>Note that TransformedSortedMap is not synchronized and is not thread-safe.
</strong>
115 If you wish to use this map from multiple threads concurrently, you must use
116 appropriate synchronization. The simplest approach is to wrap this map
117 using
<CODE>Collections.synchronizedSortedMap(java.util.SortedMap)
</CODE>. This class may throw
118 exceptions when accessed by concurrent threads without synchronization.
120 This class is Serializable from Commons Collections
3.1.
125 <DT><B>Since:
</B></DT>
126 <DD>Commons Collections
3.0</DD>
127 <DT><B>Version:
</B></DT>
128 <DD>$Revision:
646777 $ $Date:
2008-
04-
10 13:
33:
15 +
0100 (Thu,
10 Apr
2008) $
</DD>
129 <DT><B>Author:
</B></DT>
130 <DD>Stephen Colebourne
</DD>
131 <DT><B>See Also:
</B><DD><A HREF=
"../../../../../serialized-form.html#org.apache.commons.collections.map.TransformedSortedMap">Serialized Form
</A></DL>
135 <!-- ======== NESTED CLASS SUMMARY ======== -->
137 <A NAME=
"nested_class_summary"><!-- --></A>
138 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
139 <TR BGCOLOR=
"#CCCCFF" CLASS=
"TableHeadingColor">
140 <TH ALIGN=
"left" COLSPAN=
"2"><FONT SIZE=
"+2">
141 <B>Nested Class Summary
</B></FONT></TH>
144 <A NAME=
"nested_classes_inherited_from_class_java.util.Map"><!-- --></A>
145 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
146 <TR BGCOLOR=
"#EEEEFF" CLASS=
"TableSubHeadingColor">
147 <TH ALIGN=
"left"><B>Nested classes/interfaces inherited from interface java.util.Map
</B></TH>
149 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
150 <TD><CODE>java.util.Map.Entry
</CODE></TD>
154 <!-- =========== FIELD SUMMARY =========== -->
156 <A NAME=
"field_summary"><!-- --></A>
157 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
158 <TR BGCOLOR=
"#CCCCFF" CLASS=
"TableHeadingColor">
159 <TH ALIGN=
"left" COLSPAN=
"2"><FONT SIZE=
"+2">
160 <B>Field Summary
</B></FONT></TH>
163 <A NAME=
"fields_inherited_from_class_org.apache.commons.collections.map.TransformedMap"><!-- --></A>
164 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
165 <TR BGCOLOR=
"#EEEEFF" CLASS=
"TableSubHeadingColor">
166 <TH ALIGN=
"left"><B>Fields inherited from class org.apache.commons.collections.map.
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html" title=
"class in org.apache.commons.collections.map">TransformedMap
</A></B></TH>
168 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
169 <TD><CODE><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html#keyTransformer">keyTransformer
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html#valueTransformer">valueTransformer
</A></CODE></TD>
172 <A NAME=
"fields_inherited_from_class_org.apache.commons.collections.map.AbstractMapDecorator"><!-- --></A>
173 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
174 <TR BGCOLOR=
"#EEEEFF" CLASS=
"TableSubHeadingColor">
175 <TH ALIGN=
"left"><B>Fields inherited from class org.apache.commons.collections.map.
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html" title=
"class in org.apache.commons.collections.map">AbstractMapDecorator
</A></B></TH>
177 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
178 <TD><CODE><A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#map">map
</A></CODE></TD>
182 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
184 <A NAME=
"constructor_summary"><!-- --></A>
185 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
186 <TR BGCOLOR=
"#CCCCFF" CLASS=
"TableHeadingColor">
187 <TH ALIGN=
"left" COLSPAN=
"2"><FONT SIZE=
"+2">
188 <B>Constructor Summary
</B></FONT></TH>
190 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
191 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
192 <CODE>protected
</CODE></FONT></TD>
193 <TD><CODE><B><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#TransformedSortedMap(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)">TransformedSortedMap
</A></B>(java.util.SortedMap
map,
194 <A HREF=
"../../../../../org/apache/commons/collections/Transformer.html" title=
"interface in org.apache.commons.collections">Transformer
</A> keyTransformer,
195 <A HREF=
"../../../../../org/apache/commons/collections/Transformer.html" title=
"interface in org.apache.commons.collections">Transformer
</A> valueTransformer)
</CODE>
198 Constructor that wraps (not copies).
</TD>
202 <!-- ========== METHOD SUMMARY =========== -->
204 <A NAME=
"method_summary"><!-- --></A>
205 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
206 <TR BGCOLOR=
"#CCCCFF" CLASS=
"TableHeadingColor">
207 <TH ALIGN=
"left" COLSPAN=
"2"><FONT SIZE=
"+2">
208 <B>Method Summary
</B></FONT></TH>
210 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
211 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
212 <CODE> java.util.Comparator
</CODE></FONT></TD>
213 <TD><CODE><B><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#comparator()">comparator
</A></B>()
</CODE>
216 </TD>
218 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
219 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
220 <CODE>static
java.util.SortedMap
</CODE></FONT></TD>
221 <TD><CODE><B><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#decorate(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)">decorate
</A></B>(java.util.SortedMap
map,
222 <A HREF=
"../../../../../org/apache/commons/collections/Transformer.html" title=
"interface in org.apache.commons.collections">Transformer
</A> keyTransformer,
223 <A HREF=
"../../../../../org/apache/commons/collections/Transformer.html" title=
"interface in org.apache.commons.collections">Transformer
</A> valueTransformer)
</CODE>
226 Factory method to create a transforming sorted map.
</TD>
228 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
229 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
230 <CODE>static
java.util.SortedMap
</CODE></FONT></TD>
231 <TD><CODE><B><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#decorateTransform(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)">decorateTransform
</A></B>(java.util.SortedMap
map,
232 <A HREF=
"../../../../../org/apache/commons/collections/Transformer.html" title=
"interface in org.apache.commons.collections">Transformer
</A> keyTransformer,
233 <A HREF=
"../../../../../org/apache/commons/collections/Transformer.html" title=
"interface in org.apache.commons.collections">Transformer
</A> valueTransformer)
</CODE>
236 Factory method to create a transforming sorted map that will transform
237 existing contents of the specified map.
</TD>
239 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
240 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
241 <CODE> java.util.Set
</CODE></FONT></TD>
242 <TD><CODE><B><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#entrySet()">entrySet
</A></B>()
</CODE>
245 </TD>
247 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
248 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
249 <CODE> java.lang.Object
</CODE></FONT></TD>
250 <TD><CODE><B><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#firstKey()">firstKey
</A></B>()
</CODE>
253 </TD>
255 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
256 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
257 <CODE>protected
java.util.SortedMap
</CODE></FONT></TD>
258 <TD><CODE><B><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#getSortedMap()">getSortedMap
</A></B>()
</CODE>
261 Gets the map being decorated.
</TD>
263 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
264 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
265 <CODE> java.util.SortedMap
</CODE></FONT></TD>
266 <TD><CODE><B><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#headMap(java.lang.Object)">headMap
</A></B>(java.lang.Object
toKey)
</CODE>
269 </TD>
271 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
272 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
273 <CODE> java.lang.Object
</CODE></FONT></TD>
274 <TD><CODE><B><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#lastKey()">lastKey
</A></B>()
</CODE>
277 </TD>
279 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
280 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
281 <CODE> java.util.SortedMap
</CODE></FONT></TD>
282 <TD><CODE><B><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#subMap(java.lang.Object, java.lang.Object)">subMap
</A></B>(java.lang.Object
fromKey,
283 java.lang.Object
toKey)
</CODE>
286 </TD>
288 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
289 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
290 <CODE> java.util.SortedMap
</CODE></FONT></TD>
291 <TD><CODE><B><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#tailMap(java.lang.Object)">tailMap
</A></B>(java.lang.Object
fromKey)
</CODE>
294 </TD>
297 <A NAME=
"methods_inherited_from_class_org.apache.commons.collections.map.TransformedMap"><!-- --></A>
298 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
299 <TR BGCOLOR=
"#EEEEFF" CLASS=
"TableSubHeadingColor">
300 <TH ALIGN=
"left"><B>Methods inherited from class org.apache.commons.collections.map.
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html" title=
"class in org.apache.commons.collections.map">TransformedMap
</A></B></TH>
302 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
303 <TD><CODE><A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html#checkSetValue(java.lang.Object)">checkSetValue
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html#decorate(java.util.Map, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)">decorate
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html#decorateTransform(java.util.Map, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)">decorateTransform
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html#isSetValueChecking()">isSetValueChecking
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html#put(java.lang.Object, java.lang.Object)">put
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html#putAll(java.util.Map)">putAll
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html#transformKey(java.lang.Object)">transformKey
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html#transformMap(java.util.Map)">transformMap
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html#transformValue(java.lang.Object)">transformValue
</A></CODE></TD>
306 <A NAME=
"methods_inherited_from_class_org.apache.commons.collections.map.AbstractMapDecorator"><!-- --></A>
307 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
308 <TR BGCOLOR=
"#EEEEFF" CLASS=
"TableSubHeadingColor">
309 <TH ALIGN=
"left"><B>Methods inherited from class org.apache.commons.collections.map.
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html" title=
"class in org.apache.commons.collections.map">AbstractMapDecorator
</A></B></TH>
311 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
312 <TD><CODE><A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#clear()">clear
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#containsKey(java.lang.Object)">containsKey
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#containsValue(java.lang.Object)">containsValue
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#equals(java.lang.Object)">equals
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#get(java.lang.Object)">get
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#getMap()">getMap
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#hashCode()">hashCode
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#isEmpty()">isEmpty
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#keySet()">keySet
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#remove(java.lang.Object)">remove
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#size()">size
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#toString()">toString
</A>,
<A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#values()">values
</A></CODE></TD>
315 <A NAME=
"methods_inherited_from_class_java.lang.Object"><!-- --></A>
316 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
317 <TR BGCOLOR=
"#EEEEFF" CLASS=
"TableSubHeadingColor">
318 <TH ALIGN=
"left"><B>Methods inherited from class java.lang.Object
</B></TH>
320 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
321 <TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait
</CODE></TD>
324 <A NAME=
"methods_inherited_from_class_java.util.Map"><!-- --></A>
325 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
326 <TR BGCOLOR=
"#EEEEFF" CLASS=
"TableSubHeadingColor">
327 <TH ALIGN=
"left"><B>Methods inherited from interface java.util.Map
</B></TH>
329 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
330 <TD><CODE>clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
</CODE></TD>
336 <!-- ========= CONSTRUCTOR DETAIL ======== -->
338 <A NAME=
"constructor_detail"><!-- --></A>
339 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
340 <TR BGCOLOR=
"#CCCCFF" CLASS=
"TableHeadingColor">
341 <TH ALIGN=
"left" COLSPAN=
"1"><FONT SIZE=
"+2">
342 <B>Constructor Detail
</B></FONT></TH>
346 <A NAME=
"TransformedSortedMap(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)"><!-- --></A><H3>
347 TransformedSortedMap
</H3>
349 protected
<B>TransformedSortedMap
</B>(java.util.SortedMap
map,
350 <A HREF=
"../../../../../org/apache/commons/collections/Transformer.html" title=
"interface in org.apache.commons.collections">Transformer
</A> keyTransformer,
351 <A HREF=
"../../../../../org/apache/commons/collections/Transformer.html" title=
"interface in org.apache.commons.collections">Transformer
</A> valueTransformer)
</PRE>
353 <DD>Constructor that wraps (not copies).
355 If there are any elements already in the collection being decorated, they
356 are NOT transformed.
</p>
359 <DT><B>Parameters:
</B><DD><CODE>map
</CODE> - the map to decorate, must not be null
<DD><CODE>keyTransformer
</CODE> - the predicate to validate the keys, null means no transformation
<DD><CODE>valueTransformer
</CODE> - the predicate to validate to values, null means no transformation
361 <DD><CODE>java.lang.IllegalArgumentException
</CODE> - if the map is null
</DL>
364 <!-- ============ METHOD DETAIL ========== -->
366 <A NAME=
"method_detail"><!-- --></A>
367 <TABLE BORDER=
"1" WIDTH=
"100%" CELLPADDING=
"3" CELLSPACING=
"0" SUMMARY=
"">
368 <TR BGCOLOR=
"#CCCCFF" CLASS=
"TableHeadingColor">
369 <TH ALIGN=
"left" COLSPAN=
"1"><FONT SIZE=
"+2">
370 <B>Method Detail
</B></FONT></TH>
374 <A NAME=
"decorate(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)"><!-- --></A><H3>
377 public static java.util.SortedMap
<B>decorate
</B>(java.util.SortedMap
map,
378 <A HREF=
"../../../../../org/apache/commons/collections/Transformer.html" title=
"interface in org.apache.commons.collections">Transformer
</A> keyTransformer,
379 <A HREF=
"../../../../../org/apache/commons/collections/Transformer.html" title=
"interface in org.apache.commons.collections">Transformer
</A> valueTransformer)
</PRE>
381 <DD>Factory method to create a transforming sorted map.
383 If there are any elements already in the map being decorated, they
385 Constrast this with
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#decorateTransform(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)"><CODE>decorateTransform(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)
</CODE></A>.
391 <DT><B>Parameters:
</B><DD><CODE>map
</CODE> - the map to decorate, must not be null
<DD><CODE>keyTransformer
</CODE> - the predicate to validate the keys, null means no transformation
<DD><CODE>valueTransformer
</CODE> - the predicate to validate to values, null means no transformation
393 <DD><CODE>java.lang.IllegalArgumentException
</CODE> - if the map is null
</DL>
398 <A NAME=
"decorateTransform(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)"><!-- --></A><H3>
399 decorateTransform
</H3>
401 public static java.util.SortedMap
<B>decorateTransform
</B>(java.util.SortedMap
map,
402 <A HREF=
"../../../../../org/apache/commons/collections/Transformer.html" title=
"interface in org.apache.commons.collections">Transformer
</A> keyTransformer,
403 <A HREF=
"../../../../../org/apache/commons/collections/Transformer.html" title=
"interface in org.apache.commons.collections">Transformer
</A> valueTransformer)
</PRE>
405 <DD>Factory method to create a transforming sorted map that will transform
406 existing contents of the specified map.
408 If there are any elements already in the map being decorated, they
409 will be transformed by this method.
410 Constrast this with
<A HREF=
"../../../../../org/apache/commons/collections/map/TransformedSortedMap.html#decorate(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)"><CODE>decorate(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)
</CODE></A>.
416 <DT><B>Parameters:
</B><DD><CODE>map
</CODE> - the map to decorate, must not be null
<DD><CODE>keyTransformer
</CODE> - the transformer to use for key conversion, null means no transformation
<DD><CODE>valueTransformer
</CODE> - the transformer to use for value conversion, null means no transformation
418 <DD><CODE>java.lang.IllegalArgumentException
</CODE> - if map is null
<DT><B>Since:
</B></DT>
419 <DD>Commons Collections
3.2</DD>
425 <A NAME=
"getSortedMap()"><!-- --></A><H3>
428 protected java.util.SortedMap
<B>getSortedMap
</B>()
</PRE>
430 <DD>Gets the map being decorated.
437 <DT><B>Returns:
</B><DD>the decorated map
</DL>
442 <A NAME=
"firstKey()"><!-- --></A><H3>
445 public java.lang.Object
<B>firstKey
</B>()
</PRE>
448 <DT><B>Specified by:
</B><DD><CODE>firstKey
</CODE> in interface
<CODE>java.util.SortedMap
</CODE></DL>
456 <A NAME=
"lastKey()"><!-- --></A><H3>
459 public java.lang.Object
<B>lastKey
</B>()
</PRE>
462 <DT><B>Specified by:
</B><DD><CODE>lastKey
</CODE> in interface
<CODE>java.util.SortedMap
</CODE></DL>
470 <A NAME=
"comparator()"><!-- --></A><H3>
473 public java.util.Comparator
<B>comparator
</B>()
</PRE>
476 <DT><B>Specified by:
</B><DD><CODE>comparator
</CODE> in interface
<CODE>java.util.SortedMap
</CODE></DL>
484 <A NAME=
"subMap(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
487 public java.util.SortedMap
<B>subMap
</B>(java.lang.Object
fromKey,
488 java.lang.Object
toKey)
</PRE>
491 <DT><B>Specified by:
</B><DD><CODE>subMap
</CODE> in interface
<CODE>java.util.SortedMap
</CODE></DL>
499 <A NAME=
"headMap(java.lang.Object)"><!-- --></A><H3>
502 public java.util.SortedMap
<B>headMap
</B>(java.lang.Object
toKey)
</PRE>
505 <DT><B>Specified by:
</B><DD><CODE>headMap
</CODE> in interface
<CODE>java.util.SortedMap
</CODE></DL>
513 <A NAME=
"tailMap(java.lang.Object)"><!-- --></A><H3>
516 public java.util.SortedMap
<B>tailMap
</B>(java.lang.Object
fromKey)
</PRE>
519 <DT><B>Specified by:
</B><DD><CODE>tailMap
</CODE> in interface
<CODE>java.util.SortedMap
</CODE></DL>
527 <A NAME=
"entrySet()"><!-- --></A><H3>
530 public java.util.Set
<B>entrySet
</B>()
</PRE>
533 <DT><B>Specified by:
</B><DD><CODE>entrySet
</CODE> in interface
<CODE>java.util.Map
</CODE><DT><B>Overrides:
</B><DD><CODE><A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html#entrySet()">entrySet
</A></CODE> in class
<CODE><A HREF=
"../../../../../org/apache/commons/collections/map/AbstractMapDecorator.html" title=
"class in org.apache.commons.collections.map">AbstractMapDecorator
</A></CODE></DL>
539 <!-- ========= END OF CLASS DATA ========= -->
543 <!-- ======= START OF BOTTOM NAVBAR ====== -->
544 <A NAME=
"navbar_bottom"><!-- --></A>
545 <A HREF=
"#skip-navbar_bottom" title=
"Skip navigation links"></A>
546 <TABLE BORDER=
"0" WIDTH=
"100%" CELLPADDING=
"1" CELLSPACING=
"0" SUMMARY=
"">
548 <TD COLSPAN=
2 BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1">
549 <A NAME=
"navbar_bottom_firstrow"><!-- --></A>
550 <TABLE BORDER=
"0" CELLPADDING=
"0" CELLSPACING=
"3" SUMMARY=
"">
551 <TR ALIGN=
"center" VALIGN=
"top">
552 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../../../overview-summary.html"><FONT CLASS=
"NavBarFont1"><B>Overview
</B></FONT></A> </TD>
553 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"package-summary.html"><FONT CLASS=
"NavBarFont1"><B>Package
</B></FONT></A> </TD>
554 <TD BGCOLOR=
"#FFFFFF" CLASS=
"NavBarCell1Rev"> <FONT CLASS=
"NavBarFont1Rev"><B>Class
</B></FONT> </TD>
555 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"class-use/TransformedSortedMap.html"><FONT CLASS=
"NavBarFont1"><B>Use
</B></FONT></A> </TD>
556 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"package-tree.html"><FONT CLASS=
"NavBarFont1"><B>Tree
</B></FONT></A> </TD>
557 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../../../deprecated-list.html"><FONT CLASS=
"NavBarFont1"><B>Deprecated
</B></FONT></A> </TD>
558 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../../../index-all.html"><FONT CLASS=
"NavBarFont1"><B>Index
</B></FONT></A> </TD>
559 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../../../help-doc.html"><FONT CLASS=
"NavBarFont1"><B>Help
</B></FONT></A> </TD>
563 <TD ALIGN=
"right" VALIGN=
"top" ROWSPAN=
3><EM>
569 <TD BGCOLOR=
"white" CLASS=
"NavBarCell2"><FONT SIZE=
"-2">
570 <A HREF=
"../../../../../org/apache/commons/collections/map/TransformedMap.html" title=
"class in org.apache.commons.collections.map"><B>PREV CLASS
</B></A>
571 <A HREF=
"../../../../../org/apache/commons/collections/map/TypedMap.html" title=
"class in org.apache.commons.collections.map"><B>NEXT CLASS
</B></A></FONT></TD>
572 <TD BGCOLOR=
"white" CLASS=
"NavBarCell2"><FONT SIZE=
"-2">
573 <A HREF=
"../../../../../index.html?org/apache/commons/collections/map/TransformedSortedMap.html" target=
"_top"><B>FRAMES
</B></A>
574 <A HREF=
"TransformedSortedMap.html" target=
"_top"><B>NO FRAMES
</B></A>
575 <SCRIPT type=
"text/javascript">
578 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
583 <A HREF=
"../../../../../allclasses-noframe.html"><B>All Classes
</B></A>
590 <TD VALIGN=
"top" CLASS=
"NavBarCell3"><FONT SIZE=
"-2">
591 SUMMARY:
NESTED
|
<A HREF=
"#fields_inherited_from_class_org.apache.commons.collections.map.TransformedMap">FIELD
</A> |
<A HREF=
"#constructor_summary">CONSTR
</A> |
<A HREF=
"#method_summary">METHOD
</A></FONT></TD>
592 <TD VALIGN=
"top" CLASS=
"NavBarCell3"><FONT SIZE=
"-2">
593 DETAIL:
FIELD
|
<A HREF=
"#constructor_detail">CONSTR
</A> |
<A HREF=
"#method_detail">METHOD
</A></FONT></TD>
596 <A NAME=
"skip-navbar_bottom"></A>
597 <!-- ======== END OF BOTTOM NAVBAR ======= -->
600 Copyright ©
2001-
2008 <a href=
"http://www.apache.org/">The Apache Software Foundation
</a>. All Rights Reserved.