KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > collections > bag > AbstractSortedBagDecorator


1 /*
2  * Copyright 2003-2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.commons.collections.bag;
17
18 import java.util.Comparator JavaDoc;
19
20 import org.apache.commons.collections.SortedBag;
21
22 /**
23  * Decorates another <code>SortedBag</code> to provide additional behaviour.
24  * <p>
25  * Methods are forwarded directly to the decorated bag.
26  *
27  * @since Commons Collections 3.0
28  * @version $Revision: 1.5 $ $Date: 2004/06/02 21:53:02 $
29  *
30  * @author Stephen Colebourne
31  */
32 public abstract class AbstractSortedBagDecorator
33         extends AbstractBagDecorator implements SortedBag {
34
35     /**
36      * Constructor only used in deserialization, do not use otherwise.
37      * @since Commons Collections 3.1
38      */
39     protected AbstractSortedBagDecorator() {
40         super();
41     }
42
43     /**
44      * Constructor that wraps (not copies).
45      *
46      * @param bag the bag to decorate, must not be null
47      * @throws IllegalArgumentException if list is null
48      */
49     protected AbstractSortedBagDecorator(SortedBag bag) {
50         super(bag);
51     }
52
53     /**
54      * Gets the bag being decorated.
55      *
56      * @return the decorated bag
57      */
58     protected SortedBag getSortedBag() {
59         return (SortedBag) getCollection();
60     }
61
62     //-----------------------------------------------------------------------
63 public Object JavaDoc first() {
64         return getSortedBag().first();
65     }
66
67     public Object JavaDoc last() {
68         return getSortedBag().last();
69     }
70
71     public Comparator JavaDoc comparator() {
72         return getSortedBag().comparator();
73     }
74
75 }
76
Popular Tags