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 java.util.Iterator;
19:
20: /**
21: * Provides basic behaviour for decorating an iterator with extra functionality.
22: * <p>
23: * All methods are forwarded to the decorated 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 James Strachan
29: * @author Stephen Colebourne
30: */
31: public class AbstractIteratorDecorator implements Iterator {
32:
33: /** The iterator being decorated */
34: protected final Iterator 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 AbstractIteratorDecorator(Iterator iterator) {
44: super ();
45: if (iterator == null) {
46: throw new IllegalArgumentException(
47: "Iterator must not be null");
48: }
49: this .iterator = iterator;
50: }
51:
52: /**
53: * Gets the iterator being decorated.
54: *
55: * @return the decorated iterator
56: */
57: protected Iterator getIterator() {
58: return iterator;
59: }
60:
61: //-----------------------------------------------------------------------
62: public boolean hasNext() {
63: return iterator.hasNext();
64: }
65:
66: public Object next() {
67: return iterator.next();
68: }
69:
70: public void remove() {
71: iterator.remove();
72: }
73:
74: }
|