View Javadoc

1   /*
2    * $Id: FreeBusy.java [Apr 14, 2004]
3    *
4    * Copyright (c) 2004, Ben Fortuna
5    * All rights reserved.
6    *
7    * Redistribution and use in source and binary forms, with or without
8    * modification, are permitted provided that the following conditions
9    * are met:
10   *
11   * 	o Redistributions of source code must retain the above copyright
12   * notice, this list of conditions and the following disclaimer.
13   *
14   * 	o Redistributions in binary form must reproduce the above copyright
15   * notice, this list of conditions and the following disclaimer in the
16   * documentation and/or other materials provided with the distribution.
17   *
18   * 	o Neither the name of Ben Fortuna nor the names of any other contributors
19   * may be used to endorse or promote products derived from this software
20   * without specific prior written permission.
21   *
22   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25   * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
26   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27   * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28   * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29   * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30   * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31   * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33   */
34  package net.fortuna.ical4j.model.property;
35  
36  import java.text.ParseException;
37  
38  import net.fortuna.ical4j.model.Parameter;
39  import net.fortuna.ical4j.model.ParameterList;
40  import net.fortuna.ical4j.model.PeriodList;
41  import net.fortuna.ical4j.model.Property;
42  import net.fortuna.ical4j.model.ValidationException;
43  import net.fortuna.ical4j.util.ParameterValidator;
44  
45  /***
46   * Defines a FREEBUSY iCalendar component property.
47   *
48   * @author benf
49   */
50  public class FreeBusy extends Property {
51  
52      private PeriodList periods;
53  
54      /***
55       * @param aList
56       *            a list of parameters for this component
57       * @param aValue
58       *            a value string for this component
59       * @throws ParseException
60       *             when the specified string is not a valid list of periods
61       */
62      public FreeBusy(final ParameterList aList, final String aValue)
63              throws ParseException {
64          this(aList, new PeriodList(aValue));
65      }
66  
67      /***
68       * @param aList
69       *            a list of parameters for this component
70       * @param pList
71       *            a list of periods
72       */
73      public FreeBusy(final ParameterList aList, final PeriodList pList) {
74          super(FREEBUSY, aList);
75  
76          periods = pList;
77      }
78  
79      /***
80       * @see net.fortuna.ical4j.model.Property#validate()
81       */
82      public final void validate() throws ValidationException {
83  
84          /*
85           * ; the following is optional, ; but MUST NOT occur more than once
86           *
87           * (";" fbtypeparam) /
88           */
89          ParameterValidator.getInstance().validateOneOrLess(Parameter.FBTYPE,
90                  getParameters());
91  
92          /*
93           * ; the following is optional, ; and MAY occur more than once
94           *
95           * (";" xparam)
96           */
97      }
98  
99      /***
100      * @return Returns the periods.
101      */
102     public final PeriodList getPeriods() {
103         return periods;
104     }
105 
106     /*
107      * (non-Javadoc)
108      *
109      * @see net.fortuna.ical4j.model.Property#getValue()
110      */
111     public String getValue() {
112         return getPeriods().toString();
113     }
114 }