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 properties.
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class PropertyList extends ArrayList implements Serializable {
michael@0: 
michael@0:     private static final long serialVersionUID = -8875923766224921031L;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public PropertyList() {
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 PropertyList(final int initialCapacity) {
michael@0:         super(initialCapacity);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Creates a deep copy of the specified property list.
michael@0:      * @param properties a property list
michael@0:      * @throws ParseException where property data cannot be parsed
michael@0:      * @throws IOException where property data cannot be read
michael@0:      * @throws URISyntaxException where a property contains an invalid URI
michael@0:      */
michael@0:     public PropertyList(PropertyList properties) throws ParseException, IOException, URISyntaxException {
michael@0:         super();
michael@0:         for (final Iterator i = properties.iterator(); i.hasNext();) {
michael@0:             final Property p = (Property) i.next();
michael@0:             add(p.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 property of specified name.
michael@0:      * @param aName name of property to return
michael@0:      * @return a property or null if no matching property found
michael@0:      */
michael@0:     public final Property getProperty(final String aName) {
michael@0:         for (final Iterator i = iterator(); i.hasNext();) {
michael@0:             final Property p = (Property) i.next();
michael@0:             if (p.getName().equalsIgnoreCase(aName)) {
michael@0:                 return p;
michael@0:             }
michael@0:         }
michael@0:         return null;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Returns a list of properties with the specified name.
michael@0:      * @param name name of properties to return
michael@0:      * @return a property list
michael@0:      */
michael@0:     public final PropertyList getProperties(final String name) {
michael@0:         final PropertyList list = new PropertyList();
michael@0:         for (final Iterator i = iterator(); i.hasNext();) {
michael@0:             final Property p = (Property) i.next();
michael@0:             if (p.getName().equalsIgnoreCase(name)) {
michael@0:                 list.add(p);
michael@0:             }
michael@0:         }
michael@0:         return list;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Add a property to the list.
michael@0:      * @param property the property to add
michael@0:      * @return true
michael@0:      * @see java.util.List#add(java.lang.Object)
michael@0:      */
michael@0:     public final boolean add(final Property property) {
michael@0:         return add((Object) property);
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.Property</code>.
michael@0:      * @param property a property to add
michael@0:      * @return true if the property is added, otherwise false
michael@3:      * @see java.util.List#add(Object)
michael@0:      */
michael@0:     public final boolean add(final Object property) {
michael@0:         if (!(property instanceof Property)) {
michael@0:             throw new IllegalArgumentException("Argument not a "
michael@0:                     + Property.class.getName());
michael@0:         }
michael@0:         return super.add(property);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Remove a property from the list.
michael@0:      * @param property the property to remove
michael@0:      * @return true if the list contained the specified property
michael@0:      * @see java.util.List#remove(java.lang.Object)
michael@0:      */
michael@0:     public final boolean remove(final Property property) {
michael@0:         return remove((Object) property);
michael@0:     }
michael@0: }