01: /*
02: * Copyright 2003-2004 The Apache Software Foundation
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
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(
46: "MapIterator must not be null");
47: }
48: this .iterator = iterator;
49: }
50:
51: /**
52: * Gets the iterator being decorated.
53: *
54: * @return the decorated iterator
55: */
56: protected MapIterator getMapIterator() {
57: return iterator;
58: }
59:
60: //-----------------------------------------------------------------------
61: public boolean hasNext() {
62: return iterator.hasNext();
63: }
64:
65: public Object next() {
66: return iterator.next();
67: }
68:
69: public void remove() {
70: iterator.remove();
71: }
72:
73: public Object getKey() {
74: return iterator.getKey();
75: }
76:
77: public Object getValue() {
78: return iterator.getValue();
79: }
80:
81: public Object setValue(Object obj) {
82: return iterator.setValue(obj);
83: }
84:
85: }
|