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.ArrayList;
michael@0: import java.util.Iterator;
michael@0: import java.util.StringTokenizer;
michael@0: 
michael@0: import net.fortuna.ical4j.util.Numbers;
michael@0: 
michael@0: /**
michael@0:  * $Id$ [29-May-2004]
michael@0:  *
michael@0:  * Defines a list of numbers.
michael@0:  * 
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class NumberList extends ArrayList implements Serializable {
michael@0:     
michael@0:     private static final long serialVersionUID = -1667481795613729889L;
michael@0: 
michael@0:     private final int minValue;
michael@0:     
michael@0:     private final int maxValue;
michael@0: 
michael@0:     private final boolean allowsNegativeValues;
michael@0:     
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public NumberList() {
michael@0:     	this(Integer.MIN_VALUE, Integer.MAX_VALUE, true);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructor with limits.
michael@0:      * @param minValue the minimum allowable value
michael@0:      * @param maxValue the maximum allowable value
michael@0:      * @param allowsNegativeValues indicates whether negative values are allowed
michael@0:      */
michael@0:     public NumberList(int minValue, int maxValue, boolean allowsNegativeValues) {
michael@0:     	this.minValue = minValue;
michael@0:     	this.maxValue = maxValue;
michael@0:         this.allowsNegativeValues = allowsNegativeValues;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructor.
michael@0:      * @param aString a string representation of a number list
michael@0:      */
michael@0:     public NumberList(final String aString) {
michael@0:     	this(aString, Integer.MIN_VALUE, Integer.MAX_VALUE, true);
michael@0:     }
michael@0:     
michael@0:     /**
michael@0:      * @param aString a string representation of a number list
michael@0:      * @param minValue the minimum allowable value
michael@0:      * @param maxValue the maximum allowable value
michael@0:      * @param allowsNegativeValues indicates whether negative values are allowed
michael@0:      */
michael@0:     public NumberList(final String aString, int minValue, int maxValue, boolean allowsNegativeValues) {
michael@0:     	this(minValue, maxValue, allowsNegativeValues);
michael@0:         final StringTokenizer t = new StringTokenizer(aString, ",");
michael@0:         while (t.hasMoreTokens()) {
michael@0:         	final int value = Numbers.parseInt(t.nextToken());
michael@0:             add(new Integer(value));
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aNumber a number to add to the list
michael@0:      * @return true if the number was added, otherwise false
michael@0:      */
michael@0:     public final boolean add(final Integer aNumber) {
michael@0:         int abs = aNumber.intValue();
michael@0:         if ((abs >> 31 | -abs >>> 31) < 0) {
michael@0:             if (!allowsNegativeValues) {
michael@0:                 throw new IllegalArgumentException("Negative value not allowed: " + aNumber);
michael@0:             }
michael@0:             abs = Math.abs(abs);
michael@0:         }
michael@0:     	if (abs < minValue || abs > maxValue) {
michael@0:     		throw new IllegalArgumentException(
michael@0:     		        "Value not in range [" + minValue + ".." + maxValue + "]: " + aNumber);
michael@0:     	}
michael@0:         return add((Object) aNumber);
michael@0:     }
michael@0:     
michael@0:     /**
michael@0:      * Overrides superclass to throw an <code>IllegalArgumentException</code>
michael@0:      * where argument is not a <code>java.lang.Integer</code>.
michael@0:      * @param arg0 an object 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 arg0) {
michael@0:         if (!(arg0 instanceof Integer)) {
michael@0:             throw new IllegalArgumentException("Argument not a " + Integer.class.getName());
michael@0:         }
michael@0:         return super.add(arg0);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aNumber a number to remove from the list
michael@0:      * @return true if the number was removed, otherwise false
michael@0:      */
michael@0:     public final boolean remove(final Integer aNumber) {
michael@0:         return remove((Object) aNumber);
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 = iterator(); i.hasNext();) {
michael@0:             b.append(i.next());
michael@0:             if (i.hasNext()) {
michael@0:                 b.append(',');
michael@0:             }
michael@0:         }
michael@0:         return b.toString();
michael@0:     }
michael@0: }