Tue, 10 Feb 2015 18:12:00 +0100
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.util.Date; |
michael@0 | 35 | |
michael@0 | 36 | import net.fortuna.ical4j.model.Dur; |
michael@0 | 37 | import net.fortuna.ical4j.model.ParameterList; |
michael@0 | 38 | import net.fortuna.ical4j.model.Property; |
michael@0 | 39 | import net.fortuna.ical4j.model.PropertyFactoryImpl; |
michael@0 | 40 | import net.fortuna.ical4j.model.ValidationException; |
michael@0 | 41 | |
michael@0 | 42 | /** |
michael@0 | 43 | * $Id$ |
michael@0 | 44 | * |
michael@0 | 45 | * Created: [Apr 6, 2004] |
michael@0 | 46 | * |
michael@0 | 47 | * Defines a DURATION iCalendar component property. |
michael@0 | 48 | * |
michael@0 | 49 | * <pre> |
michael@0 | 50 | * 4.3.6 Duration |
michael@0 | 51 | * |
michael@0 | 52 | * Value Name: DURATION |
michael@0 | 53 | * |
michael@0 | 54 | * Purpose: This value type is used to identify properties that contain |
michael@0 | 55 | * a duration of time. |
michael@0 | 56 | * |
michael@0 | 57 | * Formal Definition: The value type is defined by the following |
michael@0 | 58 | * notation: |
michael@0 | 59 | * |
michael@0 | 60 | * dur-value = (["+"] / "-") "P" (dur-date / dur-time / dur-week) |
michael@0 | 61 | * |
michael@0 | 62 | * dur-date = dur-day [dur-time] |
michael@0 | 63 | * dur-time = "T" (dur-hour / dur-minute / dur-second) |
michael@0 | 64 | * dur-week = 1*DIGIT "W" |
michael@0 | 65 | * dur-hour = 1*DIGIT "H" [dur-minute] |
michael@0 | 66 | * dur-minute = 1*DIGIT "M" [dur-second] |
michael@0 | 67 | * dur-second = 1*DIGIT "S" |
michael@0 | 68 | * dur-day = 1*DIGIT "D" |
michael@0 | 69 | * |
michael@0 | 70 | * Description: If the property permits, multiple "duration" values are |
michael@0 | 71 | * specified by a COMMA character (US-ASCII decimal 44) separated list |
michael@0 | 72 | * of values. The format is expressed as the [ISO 8601] basic format for |
michael@0 | 73 | * the duration of time. The format can represent durations in terms of |
michael@0 | 74 | * weeks, days, hours, minutes, and seconds. |
michael@0 | 75 | * |
michael@0 | 76 | * No additional content value encoding (i.e., BACKSLASH character |
michael@0 | 77 | * encoding) are defined for this value type. |
michael@0 | 78 | * |
michael@0 | 79 | * Example: A duration of 15 days, 5 hours and 20 seconds would be: |
michael@0 | 80 | * |
michael@0 | 81 | * P15DT5H0M20S |
michael@0 | 82 | * |
michael@0 | 83 | * A duration of 7 weeks would be: |
michael@0 | 84 | * |
michael@0 | 85 | * P7W |
michael@0 | 86 | * </pre> |
michael@0 | 87 | * |
michael@0 | 88 | * @author Ben Fortuna |
michael@0 | 89 | */ |
michael@0 | 90 | public class Duration extends Property { |
michael@0 | 91 | |
michael@0 | 92 | private static final long serialVersionUID = 9144969653829796798L; |
michael@0 | 93 | |
michael@0 | 94 | private Dur duration; |
michael@0 | 95 | |
michael@0 | 96 | /** |
michael@0 | 97 | * Default constructor. |
michael@0 | 98 | */ |
michael@0 | 99 | public Duration() { |
michael@0 | 100 | super(DURATION, PropertyFactoryImpl.getInstance()); |
michael@0 | 101 | } |
michael@0 | 102 | |
michael@0 | 103 | /** |
michael@0 | 104 | * @param aList a list of parameters for this component |
michael@0 | 105 | * @param aValue a value string for this component |
michael@0 | 106 | */ |
michael@0 | 107 | public Duration(final ParameterList aList, final String aValue) { |
michael@0 | 108 | super(DURATION, aList, PropertyFactoryImpl.getInstance()); |
michael@0 | 109 | setValue(aValue); |
michael@0 | 110 | } |
michael@0 | 111 | |
michael@0 | 112 | /** |
michael@0 | 113 | * @param duration a duration value |
michael@0 | 114 | */ |
michael@0 | 115 | public Duration(final Dur duration) { |
michael@0 | 116 | super(DURATION, PropertyFactoryImpl.getInstance()); |
michael@0 | 117 | this.duration = duration; |
michael@0 | 118 | } |
michael@0 | 119 | |
michael@0 | 120 | /** |
michael@0 | 121 | * @param aList a list of parameters for this component |
michael@0 | 122 | * @param duration a duration value |
michael@0 | 123 | */ |
michael@0 | 124 | public Duration(final ParameterList aList, final Dur duration) { |
michael@0 | 125 | super(DURATION, aList, PropertyFactoryImpl.getInstance()); |
michael@0 | 126 | setDuration(duration); |
michael@0 | 127 | } |
michael@0 | 128 | |
michael@0 | 129 | /** |
michael@0 | 130 | * Constructs a new duration representing the time between the specified start date and end date. |
michael@0 | 131 | * @param start the starting time for the duration |
michael@0 | 132 | * @param end the end time for the duration |
michael@0 | 133 | */ |
michael@0 | 134 | public Duration(final Date start, final Date end) { |
michael@0 | 135 | super(DURATION, PropertyFactoryImpl.getInstance()); |
michael@0 | 136 | setDuration(new Dur(start, end)); |
michael@0 | 137 | } |
michael@0 | 138 | |
michael@0 | 139 | /** |
michael@0 | 140 | * @return Returns the duration. |
michael@0 | 141 | */ |
michael@0 | 142 | public final Dur getDuration() { |
michael@0 | 143 | return duration; |
michael@0 | 144 | } |
michael@0 | 145 | |
michael@0 | 146 | /** |
michael@0 | 147 | * {@inheritDoc} |
michael@0 | 148 | */ |
michael@0 | 149 | public final void setValue(final String aValue) { |
michael@0 | 150 | // duration = DurationFormat.getInstance().parse(aValue); |
michael@0 | 151 | duration = new Dur(aValue); |
michael@0 | 152 | } |
michael@0 | 153 | |
michael@0 | 154 | /** |
michael@0 | 155 | * {@inheritDoc} |
michael@0 | 156 | */ |
michael@0 | 157 | public final String getValue() { |
michael@0 | 158 | // return DurationFormat.getInstance().format(getDuration()); |
michael@0 | 159 | return duration.toString(); |
michael@0 | 160 | } |
michael@0 | 161 | |
michael@0 | 162 | /** |
michael@0 | 163 | * @param duration The duration to set. |
michael@0 | 164 | */ |
michael@0 | 165 | public final void setDuration(final Dur duration) { |
michael@0 | 166 | this.duration = duration; |
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 | // TODO: Auto-generated method stub |
michael@0 | 174 | } |
michael@0 | 175 | } |