• file
• revisions
• annotate
• diff
• comparison
• raw

src/net/fortuna/ical4j/model/property/Sequence.java@45d57ecba757 (annotated)

src/net/fortuna/ical4j/model/property/Sequence.java

Tue, 10 Feb 2015 19:58:00 +0100

author

Michael Schloh von Bennewitz <michael@schloh.com>

date

Tue, 10 Feb 2015 19:58:00 +0100

changeset 4

45d57ecba757

permissions

-rw-r--r--

Upgrade the upgraded ical4j component to use org.apache.commons.lang3.

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 net.fortuna.ical4j.model.ParameterList;
michael@0	35	import net.fortuna.ical4j.model.Property;
michael@0	36	import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0	37	import net.fortuna.ical4j.model.ValidationException;
michael@0	38
michael@0	39	/**
michael@0	40	* $Id$
michael@0	41	*
michael@0	42	* Created: [Apr 6, 2004]
michael@0	43	*
michael@0	44	* Defines a SEQUENCE iCalendar component property.
michael@0	45	*
michael@0	46	* <pre>
michael@0	47	* 4.8.7.4 Sequence Number
michael@0	48	*
michael@0	49	* Property Name: SEQUENCE
michael@0	50	*
michael@0	51	* Purpose: This property defines the revision sequence number of the
michael@0	52	* calendar component within a sequence of revisions.
michael@0	53	*
michael@0	54	* Value Type: integer
michael@0	55	*
michael@0	56	* Property Parameters: Non-standard property parameters can be
michael@0	57	* specified on this property.
michael@0	58	*
michael@0	59	* Conformance: The property can be specified in &quot;VEVENT&quot;, &quot;VTODO&quot; or
michael@0	60	* &quot;VJOURNAL&quot; calendar component.
michael@0	61	*
michael@0	62	* Description: When a calendar component is created, its sequence
michael@0	63	* number is zero (US-ASCII decimal 48). It is monotonically incremented
michael@0	64	* by the &quot;Organizer's&quot; CUA each time the &quot;Organizer&quot; makes a
michael@0	65	* significant revision to the calendar component. When the &quot;Organizer&quot;
michael@0	66	* makes changes to one of the following properties, the sequence number
michael@0	67	* MUST be incremented:
michael@0	68	*
michael@0	69	* . &quot;DTSTART&quot;
michael@0	70	*
michael@0	71	* . &quot;DTEND&quot;
michael@0	72	*
michael@0	73	* . &quot;DUE&quot;
michael@0	74	*
michael@0	75	* . &quot;RDATE&quot;
michael@0	76	*
michael@0	77	* . &quot;RRULE&quot;
michael@0	78	*
michael@0	79	* . &quot;EXDATE&quot;
michael@0	80	*
michael@0	81	* . &quot;EXRULE&quot;
michael@0	82	*
michael@0	83	* . &quot;STATUS&quot;
michael@0	84	*
michael@0	85	* In addition, changes made by the &quot;Organizer&quot; to other properties can
michael@0	86	* also force the sequence number to be incremented. The &quot;Organizer&quot; CUA
michael@0	87	* MUST increment the sequence number when ever it makes changes to
michael@0	88	* properties in the calendar component that the &quot;Organizer&quot; deems will
michael@0	89	* jeopardize the validity of the participation status of the
michael@0	90	* &quot;Attendees&quot;. For example, changing the location of a meeting from one
michael@0	91	* locale to another distant locale could effectively impact the
michael@0	92	* participation status of the &quot;Attendees&quot;.
michael@0	93	*
michael@0	94	* The &quot;Organizer&quot; includes this property in an iCalendar object that it
michael@0	95	* sends to an &quot;Attendee&quot; to specify the current version of the calendar
michael@0	96	* component.
michael@0	97	*
michael@0	98	* The &quot;Attendee&quot; includes this property in an iCalendar object that it
michael@0	99	* sends to the &quot;Organizer&quot; to specify the version of the calendar
michael@0	100	* component that the &quot;Attendee&quot; is referring to.
michael@0	101	*
michael@0	102	* A change to the sequence number is not the mechanism that an
michael@0	103	* &quot;Organizer&quot; uses to request a response from the &quot;Attendees&quot;. The
michael@0	104	* &quot;RSVP&quot; parameter on the &quot;ATTENDEE&quot; property is used by the
michael@0	105	* &quot;Organizer&quot; to indicate that a response from the &quot;Attendees&quot; is
michael@0	106	* requested.
michael@0	107	*
michael@0	108	* Format Definition: This property is defined by the following
michael@0	109	* notation:
michael@0	110	*
michael@0	111	* seq = &quot;SEQUENCE&quot; seqparam &quot;:&quot; integer CRLF
michael@0	112	* ; Default is &quot;0&quot;
michael@0	113	*
michael@0	114	* seqparam = *(&quot;;&quot; xparam)
michael@0	115	*
michael@0	116	* Example: The following is an example of this property for a calendar
michael@0	117	* component that was just created by the &quot;Organizer&quot;.
michael@0	118	*
michael@0	119	* SEQUENCE:0
michael@0	120	*
michael@0	121	* The following is an example of this property for a calendar component
michael@0	122	* that has been revised two different times by the &quot;Organizer&quot;.
michael@0	123	*
michael@0	124	* SEQUENCE:2
michael@0	125	* </pre>
michael@0	126	*
michael@0	127	* @author Ben Fortuna
michael@0	128	*/
michael@0	129	public class Sequence extends Property {
michael@0	130
michael@0	131	private static final long serialVersionUID = -1606972893204822853L;
michael@0	132
michael@0	133	private int sequenceNo;
michael@0	134
michael@0	135	/**
michael@0	136	* Default constructor.
michael@0	137	*/
michael@0	138	public Sequence() {
michael@0	139	super(SEQUENCE, PropertyFactoryImpl.getInstance());
michael@0	140	sequenceNo = 0;
michael@0	141	}
michael@0	142
michael@0	143	/**
michael@0	144	* @param aValue a value string for this component
michael@0	145	*/
michael@0	146	public Sequence(final String aValue) {
michael@0	147	super(SEQUENCE, PropertyFactoryImpl.getInstance());
michael@0	148	setValue(aValue);
michael@0	149	}
michael@0	150
michael@0	151	/**
michael@0	152	* @param aList a list of parameters for this component
michael@0	153	* @param aValue a value string for this component
michael@0	154	*/
michael@0	155	public Sequence(final ParameterList aList, final String aValue) {
michael@0	156	super(SEQUENCE, aList, PropertyFactoryImpl.getInstance());
michael@0	157	setValue(aValue);
michael@0	158	}
michael@0	159
michael@0	160	/**
michael@0	161	* @param aSequenceNo a sequence number
michael@0	162	*/
michael@0	163	public Sequence(final int aSequenceNo) {
michael@0	164	super(SEQUENCE, PropertyFactoryImpl.getInstance());
michael@0	165	sequenceNo = aSequenceNo;
michael@0	166	}
michael@0	167
michael@0	168	/**
michael@0	169	* @param aList a list of parameters for this component
michael@0	170	* @param aSequenceNo a sequence number
michael@0	171	*/
michael@0	172	public Sequence(final ParameterList aList, final int aSequenceNo) {
michael@0	173	super(SEQUENCE, aList, PropertyFactoryImpl.getInstance());
michael@0	174	sequenceNo = aSequenceNo;
michael@0	175	}
michael@0	176
michael@0	177	/**
michael@0	178	* @return Returns the sequenceNo.
michael@0	179	*/
michael@0	180	public final int getSequenceNo() {
michael@0	181	return sequenceNo;
michael@0	182	}
michael@0	183
michael@0	184	/**
michael@0	185	* {@inheritDoc}
michael@0	186	*/
michael@0	187	public final void setValue(final String aValue) {
michael@0	188	sequenceNo = Integer.parseInt(aValue);
michael@0	189	}
michael@0	190
michael@0	191	/**
michael@0	192	* {@inheritDoc}
michael@0	193	*/
michael@0	194	public final String getValue() {
michael@0	195	return String.valueOf(getSequenceNo());
michael@0	196	}
michael@0	197
michael@0	198	/**
michael@0	199	* {@inheritDoc}
michael@0	200	*/
michael@0	201	public final void validate() throws ValidationException {
michael@0	202	// TODO: Auto-generated method stub
michael@0	203	}
michael@0	204	}