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.OrderedMapIterator;
19:
20: /**
21: * Provides basic behaviour for decorating an ordered 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 AbstractOrderedMapIteratorDecorator implements
31: OrderedMapIterator {
32:
33: /** The iterator being decorated */
34: protected final OrderedMapIterator iterator;
35:
36: //-----------------------------------------------------------------------
37: /**
38: * Constructor that decorates the specified iterator.
39: *
40: * @param iterator the iterator to decorate, must not be null
41: * @throws IllegalArgumentException if the collection is null
42: */
43: public AbstractOrderedMapIteratorDecorator(
44: OrderedMapIterator iterator) {
45: super ();
46: if (iterator == null) {
47: throw new IllegalArgumentException(
48: "OrderedMapIterator must not be null");
49: }
50: this .iterator = iterator;
51: }
52:
53: /**
54: * Gets the iterator being decorated.
55: *
56: * @return the decorated iterator
57: */
58: protected OrderedMapIterator getOrderedMapIterator() {
59: return iterator;
60: }
61:
62: //-----------------------------------------------------------------------
63: public boolean hasNext() {
64: return iterator.hasNext();
65: }
66:
67: public Object next() {
68: return iterator.next();
69: }
70:
71: public boolean hasPrevious() {
72: return iterator.hasPrevious();
73: }
74:
75: public Object previous() {
76: return iterator.previous();
77: }
78:
79: public void remove() {
80: iterator.remove();
81: }
82:
83: public Object getKey() {
84: return iterator.getKey();
85: }
86:
87: public Object getValue() {
88: return iterator.getValue();
89: }
90:
91: public Object setValue(Object obj) {
92: return iterator.setValue(obj);
93: }
94:
95: }
|