001package biweekly.property;
002
003import java.util.Date;
004
005import biweekly.parameter.Range;
006
007/*
008 Copyright (c) 2013, Michael Angstadt
009 All rights reserved.
010
011 Redistribution and use in source and binary forms, with or without
012 modification, are permitted provided that the following conditions are met: 
013
014 1. Redistributions of source code must retain the above copyright notice, this
015 list of conditions and the following disclaimer. 
016 2. Redistributions in binary form must reproduce the above copyright notice,
017 this list of conditions and the following disclaimer in the documentation
018 and/or other materials provided with the distribution. 
019
020 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
021 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
022 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
023 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
024 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
025 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
026 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
027 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
028 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
029 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030 */
031
032/**
033 * <p>
034 * Records the original value of the {@link DateStart} property if a recurrence
035 * instance has been modified. It is used in conjunction with the {@link Uid}
036 * and {@link Sequence} properties to uniquely identify a recurrence instance.
037 * </p>
038 * <p>
039 * <b>Code sample:</b>
040 * 
041 * <pre class="brush:java">
042 * VEvent event = new VEvent();
043 * 
044 * //date-time value
045 * Date datetime = ...
046 * RecurrenceId recurrenceId = new RecurrenceId(datetime);
047 * event.setRecurrenceId(recurrenceId);
048 * 
049 * //date value
050 * Date date = ...
051 * RecurrenceId recurrenceId = new RecurrenceId(date, false);
052 * event.setRecurrenceId(recurrenceId);
053 * </pre>
054 * 
055 * </p>
056 * @author Michael Angstadt
057 * @see <a href="http://tools.ietf.org/html/rfc5545#page-112">RFC 5545 p.112-4</a>
058 */
059public class RecurrenceId extends DateOrDateTimeProperty {
060        /**
061         * Creates a recurrence ID property.
062         * @param originalStartDate the original start date
063         */
064        public RecurrenceId(Date originalStartDate) {
065                this(originalStartDate, true);
066        }
067
068        /**
069         * Creates a recurrence ID property.
070         * @param originalStartDate the original start date
071         * @param hasTime true to include the time component of the date, false not
072         * to
073         */
074        public RecurrenceId(Date originalStartDate, boolean hasTime) {
075                super(originalStartDate, hasTime);
076        }
077
078        /**
079         * Gets the effective range of recurrence instances from the instance
080         * specified by this property.
081         * @return the range or null if not set
082         * @see <a href="http://tools.ietf.org/html/rfc5545#page-23">RFC 5545 p.23-4</a>
083         */
084        public Range getRange() {
085                return parameters.getRange();
086        }
087
088        /**
089         * Sets the effective range of recurrence instances from the instance
090         * specified by this property.
091         * @param range the range or null to remove
092         * @see <a href="http://tools.ietf.org/html/rfc5545#page-23">RFC 5545 p.23-4</a>
093         */
094        public void setRange(Range range) {
095                parameters.setRange(range);
096        }
097}