KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > ozoneDB > collections > OzoneSortedMap


1 // You can redistribute this software and/or modify it under the terms of
2
// the Ozone Library License version 1 published by ozone-db.org.
3
//
4
// This file is
5
// Copyright (C) 2002-@year@ Leo Mekenkamp. All rights reserved.
6
// $Id: OzoneSortedMap.java,v 1.1 2002/10/24 15:41:16 per_nyfelt Exp $
7

8 package org.ozoneDB.collections;
9
10 import java.util.SortedMap JavaDoc;
11
12 /**
13  * See the overall description on {@link org.ozoneDB.collections.OzoneCollection}.
14  * @author <a HREF="mailto:ozoneATmekenkampD0Tcom">Leo Mekenkamp (mind the anti-sp@m)</a>
15  */

16 public interface OzoneSortedMap extends OzoneMap, SortedMap JavaDoc {
17     
18     /**
19      * <p>Returns a <code>SortedMap</code> that contains the same entries as this
20      * persistent one; it is (by nature of the client-server enviromnent) always
21      * a 'deep' copy of this <code>OzoneSortedMap</code>. I.e. the contents of
22      * this <code>OzoneSortedMap</code> instance are always copied to the client
23      * by use of serialization.</p>
24      */

25     public SortedMap JavaDoc getClientSortedMap();
26
27     /**
28      * <p>Basically nothing more than a typecasted <code>HeadMap</code> method.
29      * Because subsets are also <code>OzoneSortedMap</code>s, this method is
30      * provided to do away with the need for a typecast.</p>
31      */

32     public OzoneSortedMap ozoneHeadMap(Object JavaDoc toKey);
33     
34     /**
35      * <p>Basically nothing more than a typecasted <code>SubMap</code> method.
36      * Because subsets are also <code>OzoneSortedMap</code>s, this method is
37      * provided to do away with the need for a typecast.</p>
38      */

39     public OzoneSortedMap ozoneSubMap(Object JavaDoc fromKey, Object JavaDoc toKey);
40     
41     /**
42      * <p>Basically nothing more than a typecasted <code>TailMap</code> method.</p>
43      * Because subsets are also <code>OzoneSortedMap</code>s, this method is
44      * provided to do away with the need for a typecast.</p>
45      */

46     public OzoneSortedMap ozoneTailMap(Object JavaDoc toKey);
47     
48 }
49
Popular Tags