src/net/fortuna/ical4j/model/property/Due.java@fb9019fb1bf7 (annotated)
src/net/fortuna/ical4j/model/property/Due.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.Date; |
| michael@0 | 37 | import net.fortuna.ical4j.model.DateTime; |
| michael@0 | 38 | import net.fortuna.ical4j.model.ParameterList; |
| michael@0 | 39 | import net.fortuna.ical4j.model.PropertyFactoryImpl; |
| michael@0 | 40 | import net.fortuna.ical4j.model.TimeZone; |
| michael@0 | 41 | import net.fortuna.ical4j.model.ValidationException; |
| michael@0 | 42 | |
| michael@0 | 43 | /** |
| michael@0 | 44 | * $Id$ |
| michael@0 | 45 | * |
| michael@0 | 46 | * Created: [Apr 6, 2004] |
| michael@0 | 47 | * |
| michael@0 | 48 | * Defines a DUE iCalendar component property. |
| michael@0 | 49 | * |
| michael@0 | 50 | * <pre> |
| michael@0 | 51 | * 4.8.2.3 Date/Time Due |
| michael@0 | 52 | * |
| michael@0 | 53 | * Property Name: DUE |
| michael@0 | 54 | * |
| michael@0 | 55 | * Purpose: This property defines the date and time that a to-do is |
| michael@0 | 56 | * expected to be completed. |
| michael@0 | 57 | * |
| michael@0 | 58 | * Value Type: The default value type is DATE-TIME. The value type can |
| michael@0 | 59 | * be set to a DATE value type. |
| michael@0 | 60 | * |
| michael@0 | 61 | * Property Parameters: Non-standard, value data type, time zone |
| michael@0 | 62 | * identifier property parameters can be specified on this property. |
| michael@0 | 63 | * |
| michael@0 | 64 | * Conformance: The property can be specified once in a "VTODO" calendar |
| michael@0 | 65 | * component. |
| michael@0 | 66 | * |
| michael@0 | 67 | * Description: The value MUST be a date/time equal to or after the |
| michael@0 | 68 | * DTSTART value, if specified. |
| michael@0 | 69 | * |
| michael@0 | 70 | * Format Definition: The property is defined by the following notation: |
| michael@0 | 71 | * |
| michael@0 | 72 | * due = "DUE" dueparam":" dueval CRLF |
| michael@0 | 73 | * |
| michael@0 | 74 | * dueparam = *( |
| michael@0 | 75 | * ; the following are optional, |
| michael@0 | 76 | * ; but MUST NOT occur more than once |
| michael@0 | 77 | * |
| michael@0 | 78 | * (";" "VALUE" "=" ("DATE-TIME" / "DATE")) / |
| michael@0 | 79 | * (";" tzidparam) / |
| michael@0 | 80 | * |
| michael@0 | 81 | * ; the following is optional, |
| michael@0 | 82 | * ; and MAY occur more than once |
| michael@0 | 83 | * |
| michael@0 | 84 | * *(";" xparam) |
| michael@0 | 85 | * |
| michael@0 | 86 | * ) |
| michael@0 | 87 | * |
| michael@0 | 88 | * |
| michael@0 | 89 | * |
| michael@0 | 90 | * dueval = date-time / date |
| michael@0 | 91 | * ;Value MUST match value type |
| michael@0 | 92 | * </pre> |
| michael@0 | 93 | * |
| michael@0 | 94 | * @author Ben Fortuna |
| michael@0 | 95 | */ |
| michael@0 | 96 | public class Due extends DateProperty { |
| michael@0 | 97 | |
| michael@0 | 98 | private static final long serialVersionUID = -2965312347832730406L; |
| michael@0 | 99 | |
| michael@0 | 100 | /** |
| michael@0 | 101 | * Default constructor. The time value is initialised to the time of instantiation. |
| michael@0 | 102 | */ |
| michael@0 | 103 | public Due() { |
| michael@0 | 104 | super(DUE, PropertyFactoryImpl.getInstance()); |
| michael@0 | 105 | // defaults to UTC time.. |
| michael@0 | 106 | setDate(new DateTime(true)); |
| michael@0 | 107 | } |
| michael@0 | 108 | |
| michael@0 | 109 | /** |
| michael@0 | 110 | * Creates a new DUE property initialised with the specified timezone. |
| michael@0 | 111 | * @param timezone initial timezone |
| michael@0 | 112 | */ |
| michael@0 | 113 | public Due(TimeZone timezone) { |
| michael@0 | 114 | super(DUE, timezone, PropertyFactoryImpl.getInstance()); |
| michael@0 | 115 | } |
| michael@0 | 116 | |
| michael@0 | 117 | /** |
| michael@0 | 118 | * Creates a new instance initialised with the parsed value. |
| michael@0 | 119 | * @param value the DUE value string to parse |
| michael@0 | 120 | * @throws ParseException where the specified string is not a valid DUE value representation |
| michael@0 | 121 | */ |
| michael@0 | 122 | public Due(final String value) throws ParseException { |
| michael@0 | 123 | super(DUE, PropertyFactoryImpl.getInstance()); |
| michael@0 | 124 | setValue(value); |
| michael@0 | 125 | } |
| michael@0 | 126 | |
| michael@0 | 127 | /** |
| michael@0 | 128 | * Creates a new DUE property initialised with the specified timezone and value. |
| michael@0 | 129 | * @param value a string representation of a DUE value |
| michael@0 | 130 | * @param timezone initial timezone |
| michael@0 | 131 | * @throws ParseException where the specified value is not a valid string |
| michael@0 | 132 | * representation |
| michael@0 | 133 | */ |
| michael@0 | 134 | public Due(String value, TimeZone timezone) throws ParseException { |
| michael@0 | 135 | super(DUE, timezone, PropertyFactoryImpl.getInstance()); |
| michael@0 | 136 | setValue(value); |
| michael@0 | 137 | } |
| michael@0 | 138 | |
| michael@0 | 139 | /** |
| michael@0 | 140 | * @param aList a list of parameters for this component |
| michael@0 | 141 | * @param aValue a value string for this component |
| michael@0 | 142 | * @throws ParseException when the specified string is not a valid date/date-time representation |
| michael@0 | 143 | */ |
| michael@0 | 144 | public Due(final ParameterList aList, final String aValue) |
| michael@0 | 145 | throws ParseException { |
| michael@0 | 146 | super(DUE, aList, PropertyFactoryImpl.getInstance()); |
| michael@0 | 147 | setValue(aValue); |
| michael@0 | 148 | } |
| michael@0 | 149 | |
| michael@0 | 150 | /** |
| michael@0 | 151 | * Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter. |
| michael@0 | 152 | * @param aDate a date |
| michael@0 | 153 | */ |
| michael@0 | 154 | public Due(final Date aDate) { |
| michael@0 | 155 | super(DUE, PropertyFactoryImpl.getInstance()); |
| michael@0 | 156 | setDate(aDate); |
| michael@0 | 157 | } |
| michael@0 | 158 | |
| michael@0 | 159 | /** |
| michael@0 | 160 | * Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter. |
| michael@0 | 161 | * @param aList a list of parameters for this component |
| michael@0 | 162 | * @param aDate a date |
| michael@0 | 163 | */ |
| michael@0 | 164 | public Due(final ParameterList aList, final Date aDate) { |
| michael@0 | 165 | super(DUE, aList, PropertyFactoryImpl.getInstance()); |
| michael@0 | 166 | setDate(aDate); |
| michael@0 | 167 | } |
| michael@0 | 168 | |
| michael@0 | 169 | /** |
| michael@0 | 170 | * {@inheritDoc} |
| michael@0 | 171 | */ |
| michael@0 | 172 | public final void validate() throws ValidationException { |
| michael@0 | 173 | super.validate(); |
| michael@0 | 174 | |
| michael@0 | 175 | /* |
| michael@0 | 176 | * ; the following are optional, ; but MUST NOT occur more than once (";" "VALUE" "=" ("DATE-TIME" / "DATE")) / |
| michael@0 | 177 | * (";" tzidparam) / |
| michael@0 | 178 | */ |
| michael@0 | 179 | |
| michael@0 | 180 | /* |
| michael@0 | 181 | * ; the following is optional, ; and MAY occur more than once (";" xparam) |
| michael@0 | 182 | */ |
| michael@0 | 183 | } |
| michael@0 | 184 | } |
