View Javadoc

1   /*
2    * $Id: DtEnd.java [Apr 6, 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  import java.util.Date;
38  
39  import net.fortuna.ical4j.model.Parameter;
40  import net.fortuna.ical4j.model.ParameterList;
41  import net.fortuna.ical4j.model.Property;
42  import net.fortuna.ical4j.model.ValidationException;
43  import net.fortuna.ical4j.model.parameter.Value;
44  import net.fortuna.ical4j.util.DateFormat;
45  import net.fortuna.ical4j.util.DateTimeFormat;
46  import net.fortuna.ical4j.util.ParameterValidator;
47  
48  /***
49   * Defines a DTEND iCalendar component property.
50   *
51   * @author benf
52   */
53  public class DtEnd extends Property {
54  
55      private Date time;
56  
57      // default value determined through inspection
58      // of iCal-generated files..
59      private boolean utc = false;
60  
61      /***
62       * @param aList
63       *            a list of parameters for this component
64       * @param aValue
65       *            a value string for this component
66       * @throws ParseException
67       *             when the specified string is not a valid date/date-time
68       *             representation
69       */
70      public DtEnd(final ParameterList aList, final String aValue)
71              throws ParseException {
72          super(DTEND, aList);
73  
74          // value can be either a date-time or a date..
75          if (aList.getParameter(Parameter.VALUE) != null
76                  && Value.DATE.equals(aList.getParameter(Parameter.VALUE)
77                          .getValue())) {
78  
79              time = DateFormat.getInstance().parse(aValue);
80          }
81          else {
82              time = DateTimeFormat.getInstance().parse(aValue);
83          }
84      }
85  
86      /***
87       * Constructor. Date or Date-Time format is determined based on the presence
88       * of a VALUE parameter.
89       *
90       * @param aList
91       *            a list of parameters for this component
92       * @param aDate
93       *            a date
94       */
95      public DtEnd(final ParameterList aList, final Date aDate) {
96          super(DTEND, aList);
97  
98          time = aDate;
99      }
100 
101     /***
102      * @see net.fortuna.ical4j.model.Property#validate()
103      */
104     public final void validate() throws ValidationException {
105 
106         /*
107          * ; the following are optional, ; but MUST NOT occur more than once
108          *
109          * (";" "VALUE" "=" ("DATE-TIME" / "DATE")) / (";" tzidparam) /
110          */
111         ParameterValidator.getInstance().validateOneOrLess(Parameter.VALUE,
112                 getParameters());
113 
114         Parameter valueParam = getParameters().getParameter(Parameter.VALUE);
115 
116         if (valueParam != null
117                 && !Value.DATE_TIME.equals(valueParam.getValue())
118                 && !Value.DATE.equals(valueParam.getValue())) { throw new ValidationException(
119                 "Parameter [" + Parameter.VALUE + "] is invalid"); }
120 
121         ParameterValidator.getInstance().validateOneOrLess(Parameter.TZID,
122                 getParameters());
123 
124         /*
125          * ; the following is optional, ; and MAY occur more than once
126          *
127          * (";" xparam)
128          */
129     }
130 
131     /***
132      * @return Returns the time.
133      */
134     public final Date getTime() {
135         return time;
136     }
137 
138     /*
139      * (non-Javadoc)
140      *
141      * @see net.fortuna.ical4j.model.Property#getValue()
142      */
143     public String getValue() {
144         if (getParameters().getParameter(Parameter.VALUE) != null
145                 && Value.DATE.equals(getParameters().getParameter(
146                         Parameter.VALUE).getValue())) { return DateFormat
147                 .getInstance().format(getTime()); }
148 
149         // return local time..
150         return DateTimeFormat.getInstance().format(getTime(), isUtc());
151     }
152 
153     /***
154      * @return Returns the utc.
155      */
156     public boolean isUtc() {
157         return utc;
158     }
159 
160     /***
161      * @param utc
162      *            The utc to set.
163      */
164     public void setUtc(boolean utc) {
165         this.utc = utc;
166     }
167 }