001package biweekly.property;
002
003/*
004 Copyright (c) 2013-2015, Michael Angstadt
005 All rights reserved.
006
007 Redistribution and use in source and binary forms, with or without
008 modification, are permitted provided that the following conditions are met: 
009
010 1. Redistributions of source code must retain the above copyright notice, this
011 list of conditions and the following disclaimer. 
012 2. Redistributions in binary form must reproduce the above copyright notice,
013 this list of conditions and the following disclaimer in the documentation
014 and/or other materials provided with the distribution. 
015
016 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
017 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
018 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
019 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
020 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
021 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
022 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
023 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
024 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
025 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
026 */
027
028/**
029 * <p>
030 * Defines a revision number for an event, to-do task, or journal entry. This
031 * number can be incremented every time a significant change is made to the
032 * component.
033 * </p>
034 * <p>
035 * <b>Code sample:</b>
036 * 
037 * <pre class="brush:java">
038 * VEvent event = ...
039 * event.setSequence(2);
040 * </pre>
041 * 
042 * </p>
043 * @author Michael Angstadt
044 * @see <a href="http://tools.ietf.org/html/rfc5545#page-138">RFC 5545
045 * p.138-9</a>
046 * @see <a href="http://tools.ietf.org/html/rfc2445#page-131">RFC 2445
047 * p.131-3</a>
048 * @see <a href="http://www.imc.org/pdi/vcal-10.doc">vCal 1.0 p.35</a>
049 */
050public class Sequence extends IntegerProperty {
051        /**
052         * Creates a sequence property.
053         * @param sequence the sequence number (e.g. "0" for the initial version,
054         * "1" for the first revision, etc)
055         */
056        public Sequence(Integer sequence) {
057                super(sequence);
058        }
059
060        /**
061         * Increments the sequence number.
062         */
063        public void increment() {
064                if (value == null) {
065                        value = 1;
066                } else {
067                        value++;
068                }
069        }
070}