v2/src/marshal/org/apache/xmlbeans/impl/marshal/util/collections/ObjectAccumulator.java

/*
* 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 "Apache" 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
*    XMLBeans", nor may "Apache" appear in their name, 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 and was
* originally based on software copyright (c) 2000-2003 BEA Systems
* Inc., <http://www.bea.com/>. For more information on the Apache Software
* Foundation, please see <http://www.apache.org/>.
*/

package org.apache.xmlbeans.impl.marshal.util.collections;


import java.lang.reflect.Array;
import java.util.Collection;


public abstract class ObjectAccumulator
    implements Accumulator
{
    private final Class componentType;
    private final boolean returnCollectionForArray;
    protected final Collection store;


    public ObjectAccumulator(Class component_type,
                             int initial_capacity,
                             boolean return_collection)
    {
        if (!return_collection) {
            if (component_type.isPrimitive()) {
                throw new AssertionError("odd: " + component_type);
            }
        }

        componentType = component_type;
        returnCollectionForArray = return_collection;

        store = createNewStore(initial_capacity);
        assert store != null;
    }

    public ObjectAccumulator(Class component_type,
                             int initial_capacity)
    {
        this(component_type, initial_capacity, false);
    }

    protected abstract Collection createNewStore(int capacity);

    public ObjectAccumulator(Class component_type)
    {
        this(component_type, Accumulator.DEFAULT_INITIAL_CAPACITY);
    }

    public void append(Object o)
    {
//        if (o != null && !componentType.isAssignableFrom(o.getClass())) {
//            String msg = "Invalid type: " + o.getClass().getName() +
//                " expecting: " + componentType.getName();
//            throw new IllegalArgumentException(msg);
//        }

        store.add(o);
    }

    public final Object getFinalArray()
    {
        if (returnCollectionForArray) {
            return store;
        } else {
            Object[] out = (Object[])Array.newInstance(componentType, store.size());
            return store.toArray(out);
        }
    }

    // use with caution
    public final Collection getStore()
    {
        return store;
    }

}