Caldavsync Sources / file revision

 /**

  * Copyright (c) 2012, Ben Fortuna

  * All rights reserved.

  *

  * Redistribution and use in source and binary forms, with or without

  * modification, are permitted provided that the following conditions

  * are met:

  *

  *  o Redistributions of source code must retain the above copyright

  * notice, this list of conditions and the following disclaimer.

  *

  *  o Redistributions in binary form must reproduce the above copyright

  * notice, this list of conditions and the following disclaimer in the

  * documentation and/or other materials provided with the distribution.

  *

  *  o Neither the name of Ben Fortuna nor the names of any other contributors

  * may be used to endorse or promote products derived from this software

  * without specific prior written permission.

  *

  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR

  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

  */

 package net.fortuna.ical4j.model.property;

 import java.text.ParseException;

 import net.fortuna.ical4j.model.Parameter;

 import net.fortuna.ical4j.model.ParameterList;

 import net.fortuna.ical4j.model.PeriodList;

 import net.fortuna.ical4j.model.Property;

 import net.fortuna.ical4j.model.PropertyFactoryImpl;

 import net.fortuna.ical4j.model.ValidationException;

 import net.fortuna.ical4j.util.ParameterValidator;

 /**

  * $Id$

  * 

  * Created: [Apr 14, 2004]

  *

  * Defines a FREEBUSY iCalendar component property.

  * 

  * <pre>

  *     4.8.2.6 Free/Busy Time

  *     

  *        Property Name: FREEBUSY

  *     

  *        Purpose: The property defines one or more free or busy time

  *        intervals.

  *     

  *        Value Type: PERIOD. The date and time values MUST be in an UTC time

  *        format.

  *     

  *        Property Parameters: Non-standard or free/busy time type property

  *        parameters can be specified on this property.

  *     

  *        Conformance: The property can be specified in a "VFREEBUSY" calendar

  *        component.

  *     

  *        Property Parameter: "FBTYPE" and non-standard parameters can be

  *        specified on this property.

  *     

  *        Description: These time periods can be specified as either a start

  *        and end date-time or a start date-time and duration. The date and

  *        time MUST be a UTC time format.

  *     

  *        "FREEBUSY" properties within the "VFREEBUSY" calendar component

  *        SHOULD be sorted in ascending order, based on start time and then end

  *        time, with the earliest periods first.

  *     

  *        The "FREEBUSY" property can specify more than one value, separated by

  *        the COMMA character (US-ASCII decimal 44). In such cases, the

  *        "FREEBUSY" property values SHOULD all be of the same "FBTYPE"

  *        property parameter type (e.g., all values of a particular "FBTYPE"

  *        listed together in a single property).

  *     

  *        Format Definition: The property is defined by the following notation:

  *     

  *          freebusy   = "FREEBUSY" fbparam ":" fbvalue

  *                       CRLF

  *     

  *          fbparam    = *(

  *                     ; the following is optional,

  *                     ; but MUST NOT occur more than once

  *     

  *                     (";" fbtypeparam) /

  *     

  *                     ; the following is optional,

  *                     ; and MAY occur more than once

  *     

  *                     (";" xparam)

  *     

  *                     )

  *     

  *          fbvalue    = period *["," period]

  *          ;Time value MUST be in the UTC time format.

  * </pre>

  * 

  * @author Ben Fortuna

  */

 public class FreeBusy extends Property {

     private static final long serialVersionUID = -6415954847619338567L;

     private PeriodList periods;

     /**

      * Default constructor.

      */

     public FreeBusy() {

         super(FREEBUSY, PropertyFactoryImpl.getInstance());

         periods = new PeriodList();

     }

     /**

      * @param aValue a freebusy value

      * @throws ParseException where the specified string is not a valid freebusy value

      */

     public FreeBusy(final String aValue) throws ParseException {

         super(FREEBUSY, PropertyFactoryImpl.getInstance());

         setValue(aValue);

     }

     /**

      * @param aList a list of parameters for this component

      * @param aValue a value string for this component

      * @throws ParseException when the specified string is not a valid list of periods

      */

     public FreeBusy(final ParameterList aList, final String aValue)

             throws ParseException {

         super(FREEBUSY, aList, PropertyFactoryImpl.getInstance());

         setValue(aValue);

     }

     /**

      * @param pList a list of periods

      */

     public FreeBusy(final PeriodList pList) {

         super(FREEBUSY, PropertyFactoryImpl.getInstance());

         if (!pList.isUtc()) {

             throw new IllegalArgumentException("Periods must be in UTC format");

         }

         periods = pList;

     }

     /**

      * @param aList a list of parameters for this component

      * @param pList a list of periods

      */

     public FreeBusy(final ParameterList aList, final PeriodList pList) {

         super(FREEBUSY, aList, PropertyFactoryImpl.getInstance());

         if (!pList.isUtc()) {

             throw new IllegalArgumentException("Periods must be in UTC format");

         }

         periods = pList;

     }

     /**

      * {@inheritDoc}

      */

     public final void validate() throws ValidationException {

         /*

          * ; the following is optional, ; but MUST NOT occur more than once (";" fbtypeparam) /

          */

         ParameterValidator.getInstance().assertOneOrLess(Parameter.FBTYPE,

                 getParameters());

         /*

          * ; the following is optional, ; and MAY occur more than once (";" xparam)

          */

         if (!periods.isUtc()) {

             throw new ValidationException("Periods must be in UTC format");

         }

     }

     /**

      * @return Returns the periods.

      */

     public final PeriodList getPeriods() {

         return periods;

     }

     /**

      * {@inheritDoc}

      */

     public final void setValue(final String aValue) throws ParseException {

         periods = new PeriodList(aValue);

     }

     /**

      * {@inheritDoc}

      */

     public final String getValue() {

         return getPeriods().toString();

     }

 }