commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scolebou...@apache.org
Subject cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections/iterators AbstractOrderedMapIteratorDecorator.java
Date Thu, 20 Nov 2003 21:53:58 GMT
scolebourne    2003/11/20 13:53:58

  Added:       collections/src/java/org/apache/commons/collections/iterators
                        AbstractOrderedMapIteratorDecorator.java
  Log:
  Add abstract decorator for OrderedMapIterator
  
  Revision  Changes    Path
  1.1                  jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/AbstractOrderedMapIteratorDecorator.java
  
  Index: AbstractOrderedMapIteratorDecorator.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/AbstractOrderedMapIteratorDecorator.java,v
1.1 2003/11/20 21:53:58 scolebourne Exp $
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2003 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowledgement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgement may appear in the software itself,
   *    if and wherever such third-party acknowledgements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  package org.apache.commons.collections.iterators;
  
  /**
   * Provides basic behaviour for decorating an ordered map iterator with extra functionality.
   * <p>
   * All methods are forwarded to the decorated map iterator.
   *
   * @since Commons Collections 3.0
   * @version $Revision: 1.1 $ $Date: 2003/11/20 21:53:58 $
   * 
   * @author Stephen Colebourne
   */
  public class AbstractOrderedMapIteratorDecorator implements OrderedMapIterator {
  
      /** The iterator being decorated */
      protected final OrderedMapIterator iterator;
  
      //-----------------------------------------------------------------------
      /**
       * Constructor that decorates the specified iterator.
       *
       * @param iterator  the iterator to decorate, must not be null
       * @throws IllegalArgumentException if the collection is null
       */
      public AbstractOrderedMapIteratorDecorator(OrderedMapIterator iterator) {
          super();
          if (iterator == null) {
              throw new IllegalArgumentException("OrderedMapIterator must not be null");
          }
          this.iterator = iterator;
      }
  
      /**
       * Gets the iterator being decorated.
       * 
       * @return the decorated iterator
       */
      protected OrderedMapIterator getOrderedMapIterator() {
          return iterator;
      }
  
      //-----------------------------------------------------------------------
      public boolean hasNext() {
          return iterator.hasNext();
      }
  
      public Object next() {
          return iterator.next();
      }
  
      public boolean hasPrevious() {
          return iterator.hasPrevious();
      }
  
      public Object previous() {
          return iterator.previous();
      }
  
      public void remove() {
          iterator.remove();
      }
      
      public Object getKey() {
          return iterator.getKey();
      }
  
      public Object getValue() {
          return iterator.getValue();
      }
  
      public Object setValue(Object obj) {
          return iterator.setValue(obj);
      }
  
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message