KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > collections > iterators > AbstractMapIteratorDecorator


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.iterators;
17
18 import org.apache.commons.collections.MapIterator;
19
20 /**
21  * Provides basic behaviour for decorating a map iterator with extra functionality.
22  * <p>
23  * All methods are forwarded to the decorated map iterator.
24  *
25  * @since Commons Collections 3.0
26  * @version $Revision: 1.6 $ $Date: 2004/02/18 00:59:50 $
27  *
28  * @author Stephen Colebourne
29  */
30 public class AbstractMapIteratorDecorator implements MapIterator {
31
32     /** The iterator being decorated */
33     protected final MapIterator iterator;
34
35     //-----------------------------------------------------------------------
36 /**
37      * Constructor that decorates the specified iterator.
38      *
39      * @param iterator the iterator to decorate, must not be null
40      * @throws IllegalArgumentException if the collection is null
41      */
42     public AbstractMapIteratorDecorator(MapIterator iterator) {
43         super();
44         if (iterator == null) {
45             throw new IllegalArgumentException JavaDoc("MapIterator must not be null");
46         }
47         this.iterator = iterator;
48     }
49
50     /**
51      * Gets the iterator being decorated.
52      *
53      * @return the decorated iterator
54      */
55     protected MapIterator getMapIterator() {
56         return iterator;
57     }
58
59     //-----------------------------------------------------------------------
60 public boolean hasNext() {
61         return iterator.hasNext();
62     }
63
64     public Object JavaDoc next() {
65         return iterator.next();
66     }
67
68     public void remove() {
69         iterator.remove();
70     }
71     
72     public Object JavaDoc getKey() {
73         return iterator.getKey();
74     }
75
76     public Object JavaDoc getValue() {
77         return iterator.getValue();
78     }
79
80     public Object JavaDoc setValue(Object JavaDoc obj) {
81         return iterator.setValue(obj);
82     }
83
84 }
85
Popular Tags