diff --git a/src/java/org/apache/commons/collections/decorators/AbstractIteratorDecorator.java b/src/java/org/apache/commons/collections/decorators/AbstractIteratorDecorator.java new file mode 100644 index 000000000..6cc9e79cf --- /dev/null +++ b/src/java/org/apache/commons/collections/decorators/AbstractIteratorDecorator.java @@ -0,0 +1,113 @@ +/* + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/AbstractIteratorDecorator.java,v 1.1 2003/05/09 16:38:16 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 acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments 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 + * . + * + */ +package org.apache.commons.collections.decorators; + +import java.util.Iterator; + +/** + * AbstractIteratorDecorator decorates another + * Iterator. + *

+ * Methods are forwarded directly to the decorated iterator. + *

+ * This class is similar to {@link org.apache.commons.collections.iterators.ProxyIterator}, + * however that class allows the iterator to be set, which is too insecure + * for some decorators. + * + * @since Commons Collections 3.0 + * @version $Revision: 1.1 $ $Date: 2003/05/09 16:38:16 $ + * + * @author Stephen Colebourne + */ +public abstract class AbstractIteratorDecorator implements Iterator { + + /** The iterator to delegate to */ + protected final Iterator iterator; + + /** + * Constructor that wraps the specified iterator. + * + * @param iterator the iterator to decorate + */ + public AbstractIteratorDecorator(Iterator iterator) { + this.iterator = iterator; + } + + /** + * Gets the decorated iterator. + * + * @return the decorated iterator + */ + protected Iterator getIterator() { + return iterator; + } + + //----------------------------------------------------------------------- + public boolean hasNext() { + return iterator.hasNext(); + } + + public Object next() { + return iterator.next(); + } + + public void remove() { + iterator.remove(); + } + +} diff --git a/src/java/org/apache/commons/collections/decorators/AbstractMapDecorator.java b/src/java/org/apache/commons/collections/decorators/AbstractMapDecorator.java new file mode 100644 index 000000000..bc0af0176 --- /dev/null +++ b/src/java/org/apache/commons/collections/decorators/AbstractMapDecorator.java @@ -0,0 +1,176 @@ +/* + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/AbstractMapDecorator.java,v 1.1 2003/05/09 16:38:16 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 acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments 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 + * . + * + */ +package org.apache.commons.collections.decorators; + +import java.util.Collection; +import java.util.Map; +import java.util.Set; + +/** + *

This Map wraps another Map + * implementation, using the wrapped instance for its default + * implementation. This class is used as a framework on which to + * build to extensions for its wrapped Map object which + * would be unavailable or inconvenient via sub-classing (but usable + * via composition).

+ * + *

This implementation does not perform any special processing with + * {@link #entrySet()}, {@link #keySet()} or {@link #values()}. Instead + * it simply returns the set/collection from the wrapped map. This may be + * undesirable, for example if you are trying to write a validating + * implementation it would provide a loophole around the validation. But, + * you might want that loophole, so this class is kept simple.

+ * + * @since Commons Collections 3.0 + * @version $Revision: 1.1 $ $Date: 2003/05/09 16:38:16 $ + * + * @author Daniel Rall + * @author Stephen Colebourne + */ +public abstract class AbstractMapDecorator implements Map { + + /** The Map to decorate */ + protected final Map map; + + /** + * Constructor that wraps (not copies). + * + * @param map the map to decorate, must not be null + * @throws IllegalArgumentException if the collection is null + */ + public AbstractMapDecorator(Map map) { + if (map == null) { + throw new IllegalArgumentException("Map must not be null"); + } + this.map = map; + } + + /** + * Gets the map being decorated. + * + * @return the decorated map + */ + protected Map getMap() { + return map; + } + + //----------------------------------------------------------------------- + public void clear() { + map.clear(); + } + + public boolean containsKey(Object key) { + return map.containsKey(key); + } + + public boolean containsValue(Object value) { + return map.containsValue(value); + } + + public Set entrySet() { + return map.entrySet(); + } + + public Object get(Object key) { + return map.get(key); + } + + public boolean isEmpty() { + return map.isEmpty(); + } + + public Set keySet() { + return map.keySet(); + } + + public Object put(Object key, Object value) { + return map.put(key, value); + } + + public void putAll(Map map) { + map.putAll(map); + } + + public Object remove(Object key) { + return map.remove(key); + } + + public int size() { + return map.size(); + } + + public Collection values() { + return map.values(); + } + + public boolean equals(Object object) { + if (object == this) { + return true; + } + return map.equals(object); + } + + public int hashCode() { + return map.hashCode(); + } + + public String toString() { + return map.toString(); + } + +} diff --git a/src/java/org/apache/commons/collections/decorators/AbstractMapEntryDecorator.java b/src/java/org/apache/commons/collections/decorators/AbstractMapEntryDecorator.java new file mode 100644 index 000000000..d240a7788 --- /dev/null +++ b/src/java/org/apache/commons/collections/decorators/AbstractMapEntryDecorator.java @@ -0,0 +1,130 @@ +/* + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/AbstractMapEntryDecorator.java,v 1.1 2003/05/09 16:38:16 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 acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments 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 + * . + * + */ +package org.apache.commons.collections.decorators; + +import java.util.Map; + +/** + *

This Map.Entry wraps another Map.Entry + * implementation, using the wrapped instance for its default + * implementation. This class is used as a framework on which to + * build to extensions for its wrapped Map object which + * would be unavailable or inconvenient via sub-classing (but usable + * via composition).

+ * + * @since Commons Collections 3.0 + * @version $Revision: 1.1 $ $Date: 2003/05/09 16:38:16 $ + * + * @author Stephen Colebourne + */ +public abstract class AbstractMapEntryDecorator implements Map.Entry { + + /** The Map.Entry to decorate */ + protected final Map.Entry entry; + + /** + * Constructor that wraps (not copies). + * + * @param map the map to decorate, must not be null + * @throws IllegalArgumentException if the collection is null + */ + public AbstractMapEntryDecorator(Map.Entry entry) { + if (entry == null) { + throw new IllegalArgumentException("Map entry must not be null"); + } + this.entry = entry; + } + + /** + * Gets the map being decorated. + * + * @return the decorated map + */ + protected Map.Entry getMapEntry() { + return entry; + } + + //----------------------------------------------------------------------- + public Object getKey() { + return entry.getKey(); + } + + public Object getValue() { + return entry.getValue(); + } + + public Object setValue(Object object) { + return entry.setValue(object); + } + + public boolean equals(Object object) { + if (object == this) { + return true; + } + return entry.equals(object); + } + + public int hashCode() { + return entry.hashCode(); + } + + public String toString() { + return entry.toString(); + } + +} diff --git a/src/java/org/apache/commons/collections/decorators/AbstractSortedMapDecorator.java b/src/java/org/apache/commons/collections/decorators/AbstractSortedMapDecorator.java new file mode 100644 index 000000000..ea7135e3f --- /dev/null +++ b/src/java/org/apache/commons/collections/decorators/AbstractSortedMapDecorator.java @@ -0,0 +1,122 @@ +/* + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/AbstractSortedMapDecorator.java,v 1.1 2003/05/09 16:38:16 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 acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments 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 + * . + * + */ +package org.apache.commons.collections.decorators; + +import java.util.Comparator; +import java.util.SortedMap; + +/** + *

This SortedMap wraps another SortedMap + * implementation, using the wrapped instance for its default + * implementation. This class is used as a framework on which to + * build to extensions for its wrapped Map object which + * would be unavailable or inconvenient via sub-classing (but usable + * via composition).

+ * + * @since Commons Collections 3.0 + * @version $Revision: 1.1 $ $Date: 2003/05/09 16:38:16 $ + * + * @author Stephen Colebourne + */ +public abstract class AbstractSortedMapDecorator extends AbstractMapDecorator implements SortedMap { + + /** + * Constructor that wraps (not copies). + * + * @param map the map to decorate, must not be null + * @throws IllegalArgumentException if the collection is null + */ + public AbstractSortedMapDecorator(SortedMap map) { + super(map); + } + + /** + * Gets the map being decorated. + * + * @return the decorated map + */ + protected SortedMap getSortedMap() { + return (SortedMap) map; + } + + //----------------------------------------------------------------------- + public Comparator comparator() { + return getSortedMap().comparator(); + } + + public Object firstKey() { + return getSortedMap().firstKey(); + } + + public SortedMap headMap(Object toKey) { + return getSortedMap().headMap(toKey); + } + + public Object lastKey() { + return getSortedMap().lastKey(); + } + + public SortedMap subMap(Object fromKey, Object toKey) { + return getSortedMap().subMap(fromKey, toKey); + } + + public SortedMap tailMap(Object fromKey) { + return getSortedMap().tailMap(fromKey); + } + +}