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.property;
michael@0: 
michael@0: import java.text.ParseException;
michael@0: 
michael@0: import net.fortuna.ical4j.model.Parameter;
michael@0: import net.fortuna.ical4j.model.ParameterList;
michael@0: import net.fortuna.ical4j.model.PeriodList;
michael@0: import net.fortuna.ical4j.model.Property;
michael@0: import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0: import net.fortuna.ical4j.model.ValidationException;
michael@0: import net.fortuna.ical4j.util.ParameterValidator;
michael@0: 
michael@0: /**
michael@0:  * $Id$
michael@0:  * 
michael@0:  * Created: [Apr 14, 2004]
michael@0:  *
michael@0:  * Defines a FREEBUSY iCalendar component property.
michael@0:  * 
michael@0:  * <pre>
michael@0:  *     4.8.2.6 Free/Busy Time
michael@0:  *     
michael@0:  *        Property Name: FREEBUSY
michael@0:  *     
michael@0:  *        Purpose: The property defines one or more free or busy time
michael@0:  *        intervals.
michael@0:  *     
michael@0:  *        Value Type: PERIOD. The date and time values MUST be in an UTC time
michael@0:  *        format.
michael@0:  *     
michael@0:  *        Property Parameters: Non-standard or free/busy time type property
michael@0:  *        parameters can be specified on this property.
michael@0:  *     
michael@0:  *        Conformance: The property can be specified in a &quot;VFREEBUSY&quot; calendar
michael@0:  *        component.
michael@0:  *     
michael@0:  *        Property Parameter: &quot;FBTYPE&quot; and non-standard parameters can be
michael@0:  *        specified on this property.
michael@0:  *     
michael@0:  *        Description: These time periods can be specified as either a start
michael@0:  *        and end date-time or a start date-time and duration. The date and
michael@0:  *        time MUST be a UTC time format.
michael@0:  *     
michael@0:  *        &quot;FREEBUSY&quot; properties within the &quot;VFREEBUSY&quot; calendar component
michael@0:  *        SHOULD be sorted in ascending order, based on start time and then end
michael@0:  *        time, with the earliest periods first.
michael@0:  *     
michael@0:  *        The &quot;FREEBUSY&quot; property can specify more than one value, separated by
michael@0:  *        the COMMA character (US-ASCII decimal 44). In such cases, the
michael@0:  *        &quot;FREEBUSY&quot; property values SHOULD all be of the same &quot;FBTYPE&quot;
michael@0:  *        property parameter type (e.g., all values of a particular &quot;FBTYPE&quot;
michael@0:  *        listed together in a single property).
michael@0:  *     
michael@0:  *        Format Definition: The property is defined by the following notation:
michael@0:  *     
michael@0:  *          freebusy   = &quot;FREEBUSY&quot; fbparam &quot;:&quot; fbvalue
michael@0:  *                       CRLF
michael@0:  *     
michael@0:  *          fbparam    = *(
michael@0:  *                     ; the following is optional,
michael@0:  *                     ; but MUST NOT occur more than once
michael@0:  *     
michael@0:  *                     (&quot;;&quot; fbtypeparam) /
michael@0:  *     
michael@0:  *                     ; the following is optional,
michael@0:  *                     ; and MAY occur more than once
michael@0:  *     
michael@0:  *                     (&quot;;&quot; xparam)
michael@0:  *     
michael@0:  *                     )
michael@0:  *     
michael@0:  *          fbvalue    = period *[&quot;,&quot; period]
michael@0:  *          ;Time value MUST be in the UTC time format.
michael@0:  * </pre>
michael@0:  * 
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class FreeBusy extends Property {
michael@0: 
michael@0:     private static final long serialVersionUID = -6415954847619338567L;
michael@0: 
michael@0:     private PeriodList periods;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public FreeBusy() {
michael@0:         super(FREEBUSY, PropertyFactoryImpl.getInstance());
michael@0:         periods = new PeriodList();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aValue a freebusy value
michael@0:      * @throws ParseException where the specified string is not a valid freebusy value
michael@0:      */
michael@0:     public FreeBusy(final String aValue) throws ParseException {
michael@0:         super(FREEBUSY, PropertyFactoryImpl.getInstance());
michael@0:         setValue(aValue);
michael@0:     }
michael@0:     
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aValue a value string for this component
michael@0:      * @throws ParseException when the specified string is not a valid list of periods
michael@0:      */
michael@0:     public FreeBusy(final ParameterList aList, final String aValue)
michael@0:             throws ParseException {
michael@0:         super(FREEBUSY, aList, PropertyFactoryImpl.getInstance());
michael@0:         setValue(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param pList a list of periods
michael@0:      */
michael@0:     public FreeBusy(final PeriodList pList) {
michael@0:         super(FREEBUSY, PropertyFactoryImpl.getInstance());
michael@0:         if (!pList.isUtc()) {
michael@0:             throw new IllegalArgumentException("Periods must be in UTC format");
michael@0:         }
michael@0:         periods = pList;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param pList a list of periods
michael@0:      */
michael@0:     public FreeBusy(final ParameterList aList, final PeriodList pList) {
michael@0:         super(FREEBUSY, aList, PropertyFactoryImpl.getInstance());
michael@0:         if (!pList.isUtc()) {
michael@0:             throw new IllegalArgumentException("Periods must be in UTC format");
michael@0:         }
michael@0:         periods = pList;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void validate() throws ValidationException {
michael@0: 
michael@0:         /*
michael@0:          * ; the following is optional, ; but MUST NOT occur more than once (";" fbtypeparam) /
michael@0:          */
michael@0:         ParameterValidator.getInstance().assertOneOrLess(Parameter.FBTYPE,
michael@0:                 getParameters());
michael@0: 
michael@0:         /*
michael@0:          * ; the following is optional, ; and MAY occur more than once (";" xparam)
michael@0:          */
michael@0:         
michael@0:         if (!periods.isUtc()) {
michael@0:             throw new ValidationException("Periods must be in UTC format");
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @return Returns the periods.
michael@0:      */
michael@0:     public final PeriodList getPeriods() {
michael@0:         return periods;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void setValue(final String aValue) throws ParseException {
michael@0:         periods = new PeriodList(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final String getValue() {
michael@0:         return getPeriods().toString();
michael@0:     }
michael@0: }