home | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Commons Collections example source code file (AbstractCollectionDecorator.java)

This example Commons Collections source code file (AbstractCollectionDecorator.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Commons Collections tags/keywords

abstractcollectiondecorator, abstractcollectiondecorator, collection, collection, illegalargumentexception, iterator, iterator, object, object, string, util

The Commons Collections AbstractCollectionDecorator.java source code

 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *      http://www.apache.org/licenses/LICENSE-2.0
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
package org.apache.commons.collections.collection;

import java.util.Collection;
import java.util.Iterator;

 * Decorates another <code>Collection to provide additional behaviour.
 * <p>
 * Each method call made on this <code>Collection is forwarded to the
 * decorated <code>Collection. This class is used as a framework on which
 * to build to extensions such as synchronized and unmodifiable behaviour. The
 * main advantage of decoration is that one decorator can wrap any implementation
 * of <code>Collection, whereas sub-classing requires a new class to be
 * written for each implementation.
 * <p>
 * This implementation does not perform any special processing with
 * {@link #iterator()}. Instead it simply returns the value from the 
 * wrapped collection. This may be undesirable, for example if you are trying
 * to write an unmodifiable implementation it might provide a loophole.
 * @since Commons Collections 3.0
 * @version $Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $
 * @author Stephen Colebourne
 * @author Paul Jack
public abstract class AbstractCollectionDecorator implements Collection {

    /** The collection being decorated */
    protected Collection collection;

     * Constructor only used in deserialization, do not use otherwise.
     * @since Commons Collections 3.1
    protected AbstractCollectionDecorator() {

     * Constructor that wraps (not copies).
     * @param coll  the collection to decorate, must not be null
     * @throws IllegalArgumentException if the collection is null
    protected AbstractCollectionDecorator(Collection coll) {
        if (coll == null) {
            throw new IllegalArgumentException("Collection must not be null");
        this.collection = coll;

     * Gets the collection being decorated.
     * @return the decorated collection
    protected Collection getCollection() {
        return collection;

    public boolean add(Object object) {
        return collection.add(object);

    public boolean addAll(Collection coll) {
        return collection.addAll(coll);

    public void clear() {

    public boolean contains(Object object) {
        return collection.contains(object);

    public boolean isEmpty() {
        return collection.isEmpty();

    public Iterator iterator() {
        return collection.iterator();

    public boolean remove(Object object) {
        return collection.remove(object);

    public int size() {
        return collection.size();

    public Object[] toArray() {
        return collection.toArray();

    public Object[] toArray(Object[] object) {
        return collection.toArray(object);

    public boolean containsAll(Collection coll) {
        return collection.containsAll(coll);

    public boolean removeAll(Collection coll) {
        return collection.removeAll(coll);

    public boolean retainAll(Collection coll) {
        return collection.retainAll(coll);

    public boolean equals(Object object) {
        if (object == this) {
            return true;
        return collection.equals(object);

    public int hashCode() {
        return collection.hashCode();

    public String toString() {
        return collection.toString();


Other Commons Collections examples (source code examples)

Here is a short list of links related to this Commons Collections AbstractCollectionDecorator.java source code file:

new blog posts


Copyright 1998-2016 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.