1 /*
2 * $Id: Completed.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.ParameterList;
40 import net.fortuna.ical4j.model.Property;
41 import net.fortuna.ical4j.util.DateTimeFormat;
42
43 /***
44 * Defines a COMPLETED iCalendar component property.
45 *
46 * @author benf
47 */
48 public class Completed extends Property {
49
50 /***
51 * NOTE: The date and time MUST be in a UTC format.
52 */
53 private Date time;
54
55 /***
56 * @param aList
57 * a list of parameters for this component
58 * @param aValue
59 * a value string for this component
60 * @throws ParseException
61 * when the specified string is not a valid date-time
62 * represenation
63 */
64 public Completed(final ParameterList aList, final String aValue)
65 throws ParseException {
66 this(aList, DateTimeFormat.getInstance().parse(aValue));
67 }
68
69 /***
70 * @param aList
71 * a list of parameters for this component
72 * @param aDate
73 * a date
74 */
75 public Completed(final ParameterList aList, final Date aDate) {
76 super(COMPLETED, aList);
77
78 time = aDate;
79 }
80
81 /***
82 * @return Returns the time.
83 */
84 public final Date getTime() {
85 return time;
86 }
87
88 /*
89 * (non-Javadoc)
90 *
91 * @see net.fortuna.ical4j.model.Property#getValue()
92 */
93 public String getValue() {
94 return DateTimeFormat.getInstance().format(getTime());
95 }
96 }