001    package biweekly.property;
002    
003    import biweekly.component.VAlarm;
004    import biweekly.component.VEvent;
005    import biweekly.component.VTodo;
006    import biweekly.util.Duration;
007    
008    /*
009     Copyright (c) 2013, Michael Angstadt
010     All rights reserved.
011    
012     Redistribution and use in source and binary forms, with or without
013     modification, are permitted provided that the following conditions are met: 
014    
015     1. Redistributions of source code must retain the above copyright notice, this
016     list of conditions and the following disclaimer. 
017     2. Redistributions in binary form must reproduce the above copyright notice,
018     this list of conditions and the following disclaimer in the documentation
019     and/or other materials provided with the distribution. 
020    
021     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
022     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
023     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
024     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
025     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
026     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
027     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
028     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
029     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
030     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
031     */
032    
033    /**
034     * <p>
035     * Defines a duration of time (for example, "2 hours and 30 minutes"). It has
036     * different meanings depending on the component it belongs to:
037     * <ul>
038     * <li>{@link VEvent} - The duration of the event (used in place of a
039     * {@link DateEnd} property).</li>
040     * <li>{@link VTodo} - The duration of the to-do task (used in place of a
041     * {@link DateEnd} property).</li>
042     * <li>{@link VAlarm} - The pause between alarm repetitions.</li>
043     * </ul>
044     * </p>
045     * 
046     * <p>
047     * <b>Examples:</b>
048     * 
049     * <pre class="brush:java">
050     * Duration duration = Duration.builder().hours(2).minutes(30).build();
051     * DurationProperty prop = new DurationProperty(duration);
052     * </pre>
053     * 
054     * </p>
055     * @author Michael Angstadt
056     * @rfc 5545 p.99
057     */
058    public class DurationProperty extends ValuedProperty<Duration> {
059            /**
060             * Creates a duration property.
061             * @param duration the duration value (e.g. "2 hours nad 30 minutes")
062             */
063            public DurationProperty(Duration duration) {
064                    super(duration);
065            }
066    }