michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.model.property;
michael@0: 
michael@0: import net.fortuna.ical4j.model.ParameterList;
michael@0: import net.fortuna.ical4j.model.Property;
michael@0: import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0: import net.fortuna.ical4j.model.ValidationException;
michael@0: 
michael@0: /**
michael@0:  * $Id$
michael@0:  * 
michael@0:  * Created: [Apr 6, 2004]
michael@0:  *
michael@0:  * Defines a SEQUENCE iCalendar component property.
michael@0:  * 
michael@0:  * <pre>
michael@0:  *     4.8.7.4 Sequence Number
michael@0:  *     
michael@0:  *        Property Name: SEQUENCE
michael@0:  *     
michael@0:  *        Purpose: This property defines the revision sequence number of the
michael@0:  *        calendar component within a sequence of revisions.
michael@0:  *     
michael@0:  *        Value Type: integer
michael@0:  *     
michael@0:  *        Property Parameters: Non-standard property parameters can be
michael@0:  *        specified on this property.
michael@0:  *     
michael@0:  *        Conformance: The property can be specified in &quot;VEVENT&quot;, &quot;VTODO&quot; or
michael@0:  *        &quot;VJOURNAL&quot; calendar component.
michael@0:  *     
michael@0:  *        Description: When a calendar component is created, its sequence
michael@0:  *        number is zero (US-ASCII decimal 48). It is monotonically incremented
michael@0:  *        by the &quot;Organizer's&quot; CUA each time the &quot;Organizer&quot; makes a
michael@0:  *        significant revision to the calendar component. When the &quot;Organizer&quot;
michael@0:  *        makes changes to one of the following properties, the sequence number
michael@0:  *        MUST be incremented:
michael@0:  *     
michael@0:  *          .  &quot;DTSTART&quot;
michael@0:  *     
michael@0:  *          .  &quot;DTEND&quot;
michael@0:  *     
michael@0:  *          .  &quot;DUE&quot;
michael@0:  *     
michael@0:  *          .  &quot;RDATE&quot;
michael@0:  *     
michael@0:  *          .  &quot;RRULE&quot;
michael@0:  *     
michael@0:  *          .  &quot;EXDATE&quot;
michael@0:  *     
michael@0:  *          .  &quot;EXRULE&quot;
michael@0:  *     
michael@0:  *          .  &quot;STATUS&quot;
michael@0:  *     
michael@0:  *        In addition, changes made by the &quot;Organizer&quot; to other properties can
michael@0:  *        also force the sequence number to be incremented. The &quot;Organizer&quot; CUA
michael@0:  *        MUST increment the sequence number when ever it makes changes to
michael@0:  *        properties in the calendar component that the &quot;Organizer&quot; deems will
michael@0:  *        jeopardize the validity of the participation status of the
michael@0:  *        &quot;Attendees&quot;. For example, changing the location of a meeting from one
michael@0:  *        locale to another distant locale could effectively impact the
michael@0:  *        participation status of the &quot;Attendees&quot;.
michael@0:  *     
michael@0:  *        The &quot;Organizer&quot; includes this property in an iCalendar object that it
michael@0:  *        sends to an &quot;Attendee&quot; to specify the current version of the calendar
michael@0:  *        component.
michael@0:  *     
michael@0:  *        The &quot;Attendee&quot; includes this property in an iCalendar object that it
michael@0:  *        sends to the &quot;Organizer&quot; to specify the version of the calendar
michael@0:  *        component that the &quot;Attendee&quot; is referring to.
michael@0:  *     
michael@0:  *        A change to the sequence number is not the mechanism that an
michael@0:  *        &quot;Organizer&quot; uses to request a response from the &quot;Attendees&quot;. The
michael@0:  *        &quot;RSVP&quot; parameter on the &quot;ATTENDEE&quot; property is used by the
michael@0:  *        &quot;Organizer&quot; to indicate that a response from the &quot;Attendees&quot; is
michael@0:  *        requested.
michael@0:  *     
michael@0:  *        Format Definition: This property is defined by the following
michael@0:  *        notation:
michael@0:  *     
michael@0:  *          seq = &quot;SEQUENCE&quot; seqparam &quot;:&quot; integer CRLF
michael@0:  *          ; Default is &quot;0&quot;
michael@0:  *     
michael@0:  *          seqparam   = *(&quot;;&quot; xparam)
michael@0:  *     
michael@0:  *        Example: The following is an example of this property for a calendar
michael@0:  *        component that was just created by the &quot;Organizer&quot;.
michael@0:  *     
michael@0:  *          SEQUENCE:0
michael@0:  *     
michael@0:  *        The following is an example of this property for a calendar component
michael@0:  *        that has been revised two different times by the &quot;Organizer&quot;.
michael@0:  *     
michael@0:  *          SEQUENCE:2
michael@0:  * </pre>
michael@0:  * 
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class Sequence extends Property {
michael@0: 
michael@0:     private static final long serialVersionUID = -1606972893204822853L;
michael@0: 
michael@0:     private int sequenceNo;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public Sequence() {
michael@0:         super(SEQUENCE, PropertyFactoryImpl.getInstance());
michael@0:         sequenceNo = 0;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aValue a value string for this component
michael@0:      */
michael@0:     public Sequence(final String aValue) {
michael@0:         super(SEQUENCE, PropertyFactoryImpl.getInstance());
michael@0:         setValue(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aValue a value string for this component
michael@0:      */
michael@0:     public Sequence(final ParameterList aList, final String aValue) {
michael@0:         super(SEQUENCE, aList, PropertyFactoryImpl.getInstance());
michael@0:         setValue(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aSequenceNo a sequence number
michael@0:      */
michael@0:     public Sequence(final int aSequenceNo) {
michael@0:         super(SEQUENCE, PropertyFactoryImpl.getInstance());
michael@0:         sequenceNo = aSequenceNo;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aSequenceNo a sequence number
michael@0:      */
michael@0:     public Sequence(final ParameterList aList, final int aSequenceNo) {
michael@0:         super(SEQUENCE, aList, PropertyFactoryImpl.getInstance());
michael@0:         sequenceNo = aSequenceNo;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @return Returns the sequenceNo.
michael@0:      */
michael@0:     public final int getSequenceNo() {
michael@0:         return sequenceNo;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void setValue(final String aValue) {
michael@0:         sequenceNo = Integer.parseInt(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final String getValue() {
michael@0:         return String.valueOf(getSequenceNo());
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void validate() throws ValidationException {
michael@0:         // TODO: Auto-generated method stub
michael@0:     }
michael@0: }