src/net/fortuna/ical4j/model/property/FreeBusy.java

Tue, 10 Feb 2015 18:12:00 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Tue, 10 Feb 2015 18:12:00 +0100
changeset 0
fb9019fb1bf7
permissions
-rw-r--r--

Import initial revisions of existing project AndroidCaldavSyncAdapater,
forked from upstream repository at 27e8a0f8495c92e0780d450bdf0c7cec77a03a55.

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.property;
michael@0 33
michael@0 34 import java.text.ParseException;
michael@0 35
michael@0 36 import net.fortuna.ical4j.model.Parameter;
michael@0 37 import net.fortuna.ical4j.model.ParameterList;
michael@0 38 import net.fortuna.ical4j.model.PeriodList;
michael@0 39 import net.fortuna.ical4j.model.Property;
michael@0 40 import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0 41 import net.fortuna.ical4j.model.ValidationException;
michael@0 42 import net.fortuna.ical4j.util.ParameterValidator;
michael@0 43
michael@0 44 /**
michael@0 45 * $Id$
michael@0 46 *
michael@0 47 * Created: [Apr 14, 2004]
michael@0 48 *
michael@0 49 * Defines a FREEBUSY iCalendar component property.
michael@0 50 *
michael@0 51 * <pre>
michael@0 52 * 4.8.2.6 Free/Busy Time
michael@0 53 *
michael@0 54 * Property Name: FREEBUSY
michael@0 55 *
michael@0 56 * Purpose: The property defines one or more free or busy time
michael@0 57 * intervals.
michael@0 58 *
michael@0 59 * Value Type: PERIOD. The date and time values MUST be in an UTC time
michael@0 60 * format.
michael@0 61 *
michael@0 62 * Property Parameters: Non-standard or free/busy time type property
michael@0 63 * parameters can be specified on this property.
michael@0 64 *
michael@0 65 * Conformance: The property can be specified in a &quot;VFREEBUSY&quot; calendar
michael@0 66 * component.
michael@0 67 *
michael@0 68 * Property Parameter: &quot;FBTYPE&quot; and non-standard parameters can be
michael@0 69 * specified on this property.
michael@0 70 *
michael@0 71 * Description: These time periods can be specified as either a start
michael@0 72 * and end date-time or a start date-time and duration. The date and
michael@0 73 * time MUST be a UTC time format.
michael@0 74 *
michael@0 75 * &quot;FREEBUSY&quot; properties within the &quot;VFREEBUSY&quot; calendar component
michael@0 76 * SHOULD be sorted in ascending order, based on start time and then end
michael@0 77 * time, with the earliest periods first.
michael@0 78 *
michael@0 79 * The &quot;FREEBUSY&quot; property can specify more than one value, separated by
michael@0 80 * the COMMA character (US-ASCII decimal 44). In such cases, the
michael@0 81 * &quot;FREEBUSY&quot; property values SHOULD all be of the same &quot;FBTYPE&quot;
michael@0 82 * property parameter type (e.g., all values of a particular &quot;FBTYPE&quot;
michael@0 83 * listed together in a single property).
michael@0 84 *
michael@0 85 * Format Definition: The property is defined by the following notation:
michael@0 86 *
michael@0 87 * freebusy = &quot;FREEBUSY&quot; fbparam &quot;:&quot; fbvalue
michael@0 88 * CRLF
michael@0 89 *
michael@0 90 * fbparam = *(
michael@0 91 * ; the following is optional,
michael@0 92 * ; but MUST NOT occur more than once
michael@0 93 *
michael@0 94 * (&quot;;&quot; fbtypeparam) /
michael@0 95 *
michael@0 96 * ; the following is optional,
michael@0 97 * ; and MAY occur more than once
michael@0 98 *
michael@0 99 * (&quot;;&quot; xparam)
michael@0 100 *
michael@0 101 * )
michael@0 102 *
michael@0 103 * fbvalue = period *[&quot;,&quot; period]
michael@0 104 * ;Time value MUST be in the UTC time format.
michael@0 105 * </pre>
michael@0 106 *
michael@0 107 * @author Ben Fortuna
michael@0 108 */
michael@0 109 public class FreeBusy extends Property {
michael@0 110
michael@0 111 private static final long serialVersionUID = -6415954847619338567L;
michael@0 112
michael@0 113 private PeriodList periods;
michael@0 114
michael@0 115 /**
michael@0 116 * Default constructor.
michael@0 117 */
michael@0 118 public FreeBusy() {
michael@0 119 super(FREEBUSY, PropertyFactoryImpl.getInstance());
michael@0 120 periods = new PeriodList();
michael@0 121 }
michael@0 122
michael@0 123 /**
michael@0 124 * @param aValue a freebusy value
michael@0 125 * @throws ParseException where the specified string is not a valid freebusy value
michael@0 126 */
michael@0 127 public FreeBusy(final String aValue) throws ParseException {
michael@0 128 super(FREEBUSY, PropertyFactoryImpl.getInstance());
michael@0 129 setValue(aValue);
michael@0 130 }
michael@0 131
michael@0 132 /**
michael@0 133 * @param aList a list of parameters for this component
michael@0 134 * @param aValue a value string for this component
michael@0 135 * @throws ParseException when the specified string is not a valid list of periods
michael@0 136 */
michael@0 137 public FreeBusy(final ParameterList aList, final String aValue)
michael@0 138 throws ParseException {
michael@0 139 super(FREEBUSY, aList, PropertyFactoryImpl.getInstance());
michael@0 140 setValue(aValue);
michael@0 141 }
michael@0 142
michael@0 143 /**
michael@0 144 * @param pList a list of periods
michael@0 145 */
michael@0 146 public FreeBusy(final PeriodList pList) {
michael@0 147 super(FREEBUSY, PropertyFactoryImpl.getInstance());
michael@0 148 if (!pList.isUtc()) {
michael@0 149 throw new IllegalArgumentException("Periods must be in UTC format");
michael@0 150 }
michael@0 151 periods = pList;
michael@0 152 }
michael@0 153
michael@0 154 /**
michael@0 155 * @param aList a list of parameters for this component
michael@0 156 * @param pList a list of periods
michael@0 157 */
michael@0 158 public FreeBusy(final ParameterList aList, final PeriodList pList) {
michael@0 159 super(FREEBUSY, aList, PropertyFactoryImpl.getInstance());
michael@0 160 if (!pList.isUtc()) {
michael@0 161 throw new IllegalArgumentException("Periods must be in UTC format");
michael@0 162 }
michael@0 163 periods = pList;
michael@0 164 }
michael@0 165
michael@0 166 /**
michael@0 167 * {@inheritDoc}
michael@0 168 */
michael@0 169 public final void validate() throws ValidationException {
michael@0 170
michael@0 171 /*
michael@0 172 * ; the following is optional, ; but MUST NOT occur more than once (";" fbtypeparam) /
michael@0 173 */
michael@0 174 ParameterValidator.getInstance().assertOneOrLess(Parameter.FBTYPE,
michael@0 175 getParameters());
michael@0 176
michael@0 177 /*
michael@0 178 * ; the following is optional, ; and MAY occur more than once (";" xparam)
michael@0 179 */
michael@0 180
michael@0 181 if (!periods.isUtc()) {
michael@0 182 throw new ValidationException("Periods must be in UTC format");
michael@0 183 }
michael@0 184 }
michael@0 185
michael@0 186 /**
michael@0 187 * @return Returns the periods.
michael@0 188 */
michael@0 189 public final PeriodList getPeriods() {
michael@0 190 return periods;
michael@0 191 }
michael@0 192
michael@0 193 /**
michael@0 194 * {@inheritDoc}
michael@0 195 */
michael@0 196 public final void setValue(final String aValue) throws ParseException {
michael@0 197 periods = new PeriodList(aValue);
michael@0 198 }
michael@0 199
michael@0 200 /**
michael@0 201 * {@inheritDoc}
michael@0 202 */
michael@0 203 public final String getValue() {
michael@0 204 return getPeriods().toString();
michael@0 205 }
michael@0 206 }

mercurial