collections-generic-4.01.src.java.org.apache.commons.collections15.list.TypedList Maven / Gradle / Ivy

// GenericsNote: deprecated and useless
/*
 *  Copyright 2003-2004 The Apache Software Foundation
 *
 *  Licensed 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.collections15.list;

import org.apache.commons.collections15.functors.InstanceofPredicate;

import java.util.List;

/**
 * Decorates another List to validate that elements
 * added are of a specific type.
 * 
 * The validation of additions is performed via an instanceof test against
 * a specified Class. If an object cannot be added to the
 * collection, an IllegalArgumentException is thrown.
 *
 * @author Stephen Colebourne
 * @author Matt Hall, John Watkinson, Matthew Hawthorne
 * @version $Revision: 1.1 $ $Date: 2005/10/11 17:05:32 $
 * @since Commons Collections 3.0
 * @deprecated Java Generics makes this class obsolete.
 */
public class TypedList {

    /**
     * Factory method to create a typed list.
     * 
     * If there are any elements already in the list being decorated, they
     * are validated.
     *
     * @param list the list to decorate, must not be null
     * @param type the type to allow into the collection, must not be null
     * @throws IllegalArgumentException if list or type is null
     * @throws IllegalArgumentException if the list contains invalid elements
     */
    public static List decorate(List list, Class type) {
        return new PredicatedList(list, InstanceofPredicate.getInstance(type));
    }

    /**
     * Restrictive constructor.
     */
    protected TypedList() {
    }

}