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.Serializable;
michael@0: import java.util.Arrays;
michael@0: import java.util.Iterator;
michael@0: import java.util.List;
michael@0: import java.util.regex.Matcher;
michael@0: import java.util.regex.Pattern;
michael@0: 
michael@0: import edu.emory.mathcs.backport.java.util.concurrent.CopyOnWriteArrayList;
michael@0: 
michael@0: import net.fortuna.ical4j.util.Strings;
michael@0: 
michael@0: /**
michael@0:  * $Id$ [23-Apr-2004]
michael@0:  *
michael@0:  * Defines a list of iCalendar text elements.
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class TextList implements Serializable {
michael@0: 
michael@0: 	private static final long serialVersionUID = -417427815871330636L;
michael@0: 	
michael@0: 	private List texts;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public TextList() {
michael@0:         texts = new CopyOnWriteArrayList();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Parses the specified string representation to create a list of categories.
michael@0:      * @param aValue a string representation of a list of categories
michael@0:      */
michael@0:     public TextList(final String aValue) {
michael@0:         texts = new CopyOnWriteArrayList();
michael@0: 
michael@0:         // match commas preceded by even number of backslashes..
michael@0:         final Pattern pattern = Pattern.compile("([^\\\\](?:\\\\{2})),|([^\\\\]),");
michael@0:         
michael@0:         final Matcher matcher = pattern.matcher(aValue);
michael@0:         String[] textValues = null;
michael@0: 
michael@0:         if (matcher.find()) {
michael@0:         	// HACK: add a marker (") for easy string splitting..
michael@0:             textValues = matcher.replaceAll("$1$2"").split(""");
michael@0:         }
michael@0:         else {
michael@0:         	// no special cases, split on commas not preceded by backslash..
michael@0:             textValues = aValue.split("(?<!\\\\),");
michael@0:         }
michael@0: 
michael@0:         for (int i = 0; i < textValues.length; i++) {
michael@0:             texts.add(Strings.unescape(textValues[i]));
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param textValues an array of text values
michael@0:      */
michael@0:     public TextList(String[] textValues) {
michael@0:         texts = Arrays.asList(textValues);
michael@0:     }
michael@0:     
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final String toString() {
michael@0:         final StringBuffer b = new StringBuffer();
michael@0:         for (final Iterator i = texts.iterator(); i.hasNext();) {
michael@0:             b.append(Strings.escape((String) i.next()));
michael@0:             if (i.hasNext()) {
michael@0:                 b.append(',');
michael@0:             }
michael@0:         }
michael@0:         return b.toString();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Add an address to the list.
michael@0:      * @param text the category to add
michael@0:      * @return true
michael@0:      * @see List#add(java.lang.Object)
michael@0:      */
michael@0:     public final boolean add(final String text) {
michael@0:         return texts.add(text);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @return boolean indicates if the list is empty
michael@0:      * @see List#isEmpty()
michael@0:      */
michael@0:     public final boolean isEmpty() {
michael@0:         return texts.isEmpty();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @return an iterator
michael@0:      * @see List#iterator()
michael@0:      */
michael@0:     public final Iterator iterator() {
michael@0:         return texts.iterator();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Remove a text from the list.
michael@0:      * @param text the text element to remove
michael@0:      * @return true if the list contained the specified text element
michael@0:      * @see List#remove(java.lang.Object)
michael@0:      */
michael@0:     public final boolean remove(final String text) {
michael@0:         return texts.remove(text);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @return the number of text elements in the list
michael@0:      * @see List#size()
michael@0:      */
michael@0:     public final int size() {
michael@0:         return texts.size();
michael@0:     }
michael@0: }