src/net/fortuna/ical4j/model/ComponentList.java

Tue, 10 Feb 2015 19:58:00 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Tue, 10 Feb 2015 19:58:00 +0100
changeset 4
45d57ecba757
parent 0
fb9019fb1bf7
permissions
-rw-r--r--

Upgrade the upgraded ical4j component to use org.apache.commons.lang3.

michael@0 1 /**
michael@0 2 * Copyright (c) 2012, Ben Fortuna
michael@0 3 * All rights reserved.
michael@0 4 *
michael@0 5 * Redistribution and use in source and binary forms, with or without
michael@0 6 * modification, are permitted provided that the following conditions
michael@0 7 * are met:
michael@0 8 *
michael@0 9 * o Redistributions of source code must retain the above copyright
michael@0 10 * notice, this list of conditions and the following disclaimer.
michael@0 11 *
michael@0 12 * o Redistributions in binary form must reproduce the above copyright
michael@0 13 * notice, this list of conditions and the following disclaimer in the
michael@0 14 * documentation and/or other materials provided with the distribution.
michael@0 15 *
michael@0 16 * o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0 17 * may be used to endorse or promote products derived from this software
michael@0 18 * without specific prior written permission.
michael@0 19 *
michael@0 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0 23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0 24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0 26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0 27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0 28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0 29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0 30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0 31 */
michael@0 32 package net.fortuna.ical4j.model;
michael@0 33
michael@0 34 import java.io.IOException;
michael@0 35 import java.io.Serializable;
michael@0 36 import java.net.URISyntaxException;
michael@0 37 import java.text.ParseException;
michael@0 38 import java.util.ArrayList;
michael@0 39 import java.util.Iterator;
michael@0 40
michael@0 41 /**
michael@0 42 * $Id$ [Apr 5, 2004]
michael@0 43 *
michael@0 44 * Defines a list of iCalendar components.
michael@0 45 * @author Ben Fortuna
michael@0 46 */
michael@0 47 public class ComponentList extends ArrayList implements Serializable {
michael@0 48
michael@0 49 private static final long serialVersionUID = 7308557606558767449L;
michael@0 50
michael@0 51 /**
michael@0 52 * Default constructor.
michael@0 53 */
michael@0 54 public ComponentList() {
michael@0 55 }
michael@0 56
michael@0 57 /**
michael@0 58 * Creates a new instance with the specified initial capacity.
michael@0 59 * @param initialCapacity the initial capacity of the list
michael@0 60 */
michael@0 61 public ComponentList(final int initialCapacity) {
michael@0 62 super(initialCapacity);
michael@0 63 }
michael@0 64
michael@0 65 /**
michael@0 66 * Creates a deep copy of the specified component list.
michael@0 67 * @param components a component list to copy
michael@0 68 * @throws IOException where an error occurs reading component data
michael@0 69 * @throws ParseException where component data cannot be parsed
michael@0 70 * @throws URISyntaxException where component data contains an invalid URI
michael@0 71 */
michael@0 72 public ComponentList(ComponentList components) throws ParseException,
michael@0 73 IOException, URISyntaxException {
michael@0 74
michael@0 75 for (final Iterator i = components.iterator(); i.hasNext();) {
michael@0 76 final Component c = (Component) i.next();
michael@0 77 add(c.copy());
michael@0 78 }
michael@0 79 }
michael@0 80
michael@0 81 /**
michael@0 82 * {@inheritDoc}
michael@0 83 */
michael@0 84 public final String toString() {
michael@0 85 final StringBuffer buffer = new StringBuffer();
michael@0 86 for (final Iterator i = iterator(); i.hasNext();) {
michael@0 87 buffer.append(i.next().toString());
michael@0 88 }
michael@0 89 return buffer.toString();
michael@0 90 }
michael@0 91
michael@0 92 /**
michael@0 93 * Returns the first component of specified name.
michael@0 94 * @param aName name of component to return
michael@0 95 * @return a component or null if no matching component found
michael@0 96 */
michael@0 97 public final Component getComponent(final String aName) {
michael@0 98 for (final Iterator i = iterator(); i.hasNext();) {
michael@0 99 final Component c = (Component) i.next();
michael@0 100 if (c.getName().equals(aName)) {
michael@0 101 return c;
michael@0 102 }
michael@0 103 }
michael@0 104 return null;
michael@0 105 }
michael@0 106
michael@0 107 /**
michael@0 108 * Returns a list containing all components with specified name.
michael@0 109 * @param name name of components to return
michael@0 110 * @return a list of components with the matching name
michael@0 111 */
michael@0 112 public final ComponentList getComponents(final String name) {
michael@0 113 final ComponentList components = new ComponentList();
michael@0 114 for (final Iterator i = iterator(); i.hasNext();) {
michael@0 115 final Component c = (Component) i.next();
michael@0 116 if (c.getName().equals(name)) {
michael@0 117 components.add(c);
michael@0 118 }
michael@0 119 }
michael@0 120 return components;
michael@0 121 }
michael@0 122
michael@0 123 /**
michael@0 124 * Add a component to the list.
michael@0 125 * @param component the component to add
michael@0 126 * @return true
michael@3 127 * @see java.util.List#add(Object)
michael@0 128 */
michael@0 129 public final boolean add(final Component component) {
michael@0 130 return add((Object) component);
michael@0 131 }
michael@0 132
michael@0 133 /**
michael@0 134 * Overrides superclass to throw an <code>IllegalArgumentException</code> where argument is not a
michael@0 135 * <code>net.fortuna.ical4j.model.Component</code>.
michael@0 136 * @param component a component to add
michael@0 137 * @return true if the object was added, otherwise false
michael@3 138 * @see java.util.List#add(Object)
michael@0 139 */
michael@0 140 public final boolean add(final Object component) {
michael@0 141 if (!(component instanceof Component)) {
michael@0 142 throw new IllegalArgumentException("Argument not a "
michael@0 143 + Component.class.getName());
michael@0 144 }
michael@0 145 return super.add(component);
michael@0 146 }
michael@0 147
michael@0 148 /**
michael@0 149 * @return boolean indicates if the list is empty
michael@3 150 * @see java.util.List#isEmpty()
michael@0 151 */
michael@0 152 // public final boolean isEmpty() {
michael@0 153 // return components.isEmpty();
michael@0 154 // }
michael@0 155 /**
michael@0 156 * @return an iterator
michael@3 157 * @see java.util.List#iterator()
michael@0 158 */
michael@0 159 // public final Iterator iterator() {
michael@0 160 // return components.iterator();
michael@0 161 // }
michael@0 162 /**
michael@0 163 * Remove a component from the list.
michael@0 164 * @param component the component to remove
michael@0 165 * @return true if the list contained the specified component
michael@3 166 * @see java.util.List#remove(java.lang.Object)
michael@0 167 */
michael@0 168 public final boolean remove(final Component component) {
michael@0 169 return remove((Object) component);
michael@0 170 }
michael@0 171
michael@0 172 /**
michael@0 173 * @return the number of components in the list
michael@3 174 * @see java.util.List#size()
michael@0 175 */
michael@0 176 // public final int size() {
michael@0 177 // return components.size();
michael@0 178 // }
michael@0 179 /**
michael@0 180 * Provides a list containing all components contained in this component list.
michael@0 181 * @return a list
michael@0 182 */
michael@0 183 // public final List toList() {
michael@0 184 // return new ArrayList(components);
michael@0 185 // }
michael@0 186 }

mercurial