michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.model;
michael@0: 
michael@0: import java.io.IOException;
michael@0: import java.io.Serializable;
michael@0: import java.net.URISyntaxException;
michael@0: import java.text.ParseException;
michael@0: import java.util.ArrayList;
michael@0: import java.util.Iterator;
michael@0: 
michael@0: /**
michael@0:  * $Id$ [Apr 5, 2004]
michael@0:  *
michael@0:  * Defines a list of iCalendar components.
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class ComponentList extends ArrayList implements Serializable {
michael@0: 
michael@0:     private static final long serialVersionUID = 7308557606558767449L;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public ComponentList() {
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Creates a new instance with the specified initial capacity.
michael@0:      * @param initialCapacity the initial capacity of the list
michael@0:      */
michael@0:     public ComponentList(final int initialCapacity) {
michael@0:         super(initialCapacity);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Creates a deep copy of the specified component list.
michael@0:      * @param components a component list to copy
michael@0:      * @throws IOException where an error occurs reading component data
michael@0:      * @throws ParseException where component data cannot be parsed
michael@0:      * @throws URISyntaxException where component data contains an invalid URI
michael@0:      */
michael@0:     public ComponentList(ComponentList components) throws ParseException,
michael@0:             IOException, URISyntaxException {
michael@0: 
michael@0:         for (final Iterator i = components.iterator(); i.hasNext();) {
michael@0:             final Component c = (Component) i.next();
michael@0:             add(c.copy());
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final String toString() {
michael@0:         final StringBuffer buffer = new StringBuffer();
michael@0:         for (final Iterator i = iterator(); i.hasNext();) {
michael@0:             buffer.append(i.next().toString());
michael@0:         }
michael@0:         return buffer.toString();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Returns the first component of specified name.
michael@0:      * @param aName name of component to return
michael@0:      * @return a component or null if no matching component found
michael@0:      */
michael@0:     public final Component getComponent(final String aName) {
michael@0:         for (final Iterator i = iterator(); i.hasNext();) {
michael@0:             final Component c = (Component) i.next();
michael@0:             if (c.getName().equals(aName)) {
michael@0:                 return c;
michael@0:             }
michael@0:         }
michael@0:         return null;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Returns a list containing all components with specified name.
michael@0:      * @param name name of components to return
michael@0:      * @return a list of components with the matching name
michael@0:      */
michael@0:     public final ComponentList getComponents(final String name) {
michael@0:         final ComponentList components = new ComponentList();
michael@0:         for (final Iterator i = iterator(); i.hasNext();) {
michael@0:             final Component c = (Component) i.next();
michael@0:             if (c.getName().equals(name)) {
michael@0:                 components.add(c);
michael@0:             }
michael@0:         }
michael@0:         return components;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Add a component to the list.
michael@0:      * @param component the component to add
michael@0:      * @return true
michael@3:      * @see java.util.List#add(Object)
michael@0:      */
michael@0:     public final boolean add(final Component component) {
michael@0:         return add((Object) component);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Overrides superclass to throw an <code>IllegalArgumentException</code> where argument is not a
michael@0:      * <code>net.fortuna.ical4j.model.Component</code>.
michael@0:      * @param component a component to add
michael@0:      * @return true if the object was added, otherwise false
michael@3:      * @see java.util.List#add(Object)
michael@0:      */
michael@0:     public final boolean add(final Object component) {
michael@0:         if (!(component instanceof Component)) {
michael@0:             throw new IllegalArgumentException("Argument not a "
michael@0:                     + Component.class.getName());
michael@0:         }
michael@0:         return super.add(component);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @return boolean indicates if the list is empty
michael@3:      * @see java.util.List#isEmpty()
michael@0:      */
michael@0:     // public final boolean isEmpty() {
michael@0:     // return components.isEmpty();
michael@0:     // }
michael@0:     /**
michael@0:      * @return an iterator
michael@3:      * @see java.util.List#iterator()
michael@0:      */
michael@0:     // public final Iterator iterator() {
michael@0:     // return components.iterator();
michael@0:     // }
michael@0:     /**
michael@0:      * Remove a component from the list.
michael@0:      * @param component the component to remove
michael@0:      * @return true if the list contained the specified component
michael@3:      * @see java.util.List#remove(java.lang.Object)
michael@0:      */
michael@0:     public final boolean remove(final Component component) {
michael@0:         return remove((Object) component);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @return the number of components in the list
michael@3:      * @see java.util.List#size()
michael@0:      */
michael@0:     // public final int size() {
michael@0:     // return components.size();
michael@0:     // }
michael@0:     /**
michael@0:      * Provides a list containing all components contained in this component list.
michael@0:      * @return a list
michael@0:      */
michael@0:     // public final List toList() {
michael@0:     // return new ArrayList(components);
michael@0:     // }
michael@0: }