KickJava   Java API By Example, From Geeks To Geeks.

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


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: OzoneSortedSet.java,v 1.1 2002/10/24 15:41:16 per_nyfelt Exp $
7

8 package org.ozoneDB.collections;
9
10 import java.util.SortedSet 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 OzoneSortedSet extends OzoneSet, SortedSet JavaDoc {
17     
18     /**
19      * <p>Returns a <code>SortedSet</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>OzoneSortedSet</code>. I.e. the contents of
22      * this <code>OzoneSortedSet</code> instance are always copied to the client
23      * by use of serialization.</p>
24      * <p>Note that the difference of calling <code>iterator()</code>
25      * compared to <code>getClientSortedSet().iterator()</code> is that in
26      * the first case you go through the real collection on the server and in
27      * the second case you go through a local copy on the client side.</p>
28      */

29     public SortedSet JavaDoc getClientSortedSet();
30     
31     /**
32      * <p>Basically nothing more than a typecasted <code>HeadSet</code> method.
33      * Because subsets are also <code>OzoneSortedSet</code>s, this method is
34      * provided to do away with the need for a typecast.</p>
35      */

36     public OzoneSortedSet ozoneHeadSet(Object JavaDoc toElement);
37     
38     /**
39      * <p>Basically nothing more than a typecasted <code>SubSet</code> method.
40      * Because subsets are also <code>OzoneSortedSet</code>s, this method is
41      * provided to do away with the need for a typecast.</p>
42      */

43     public OzoneSortedSet ozoneSubSet(Object JavaDoc fromElement, Object JavaDoc toElement);
44     
45     /**
46      * <p>Basically nothing more than a typecasted <code>TailSet</code> method.</p>
47      * Because subsets are also <code>OzoneSortedSet</code>s, this method is
48      * provided to do away with the need for a typecast.</p>
49      */

50     public OzoneSortedSet ozoneTailSet(Object JavaDoc toElement);
51     
52 }
53
Popular Tags