Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.property

public Class Sequence

extends Property
Class Inheritance
Imports
net.fortuna.ical4j.model.Content, .ParameterList, .Property, .PropertyFactory, net.fortuna.ical4j.validate.ValidationException, .ValidationResult, net.fortuna.ical4j.validate.property.ChangeManagementPropertyValidators, org.jetbrains.annotations.NotNull, java.util.Comparator

$Id$

Created: [Apr 6, 2004]

Defines a SEQUENCE iCalendar component property.

    4.8.7.4 Sequence Number

       Property Name: SEQUENCE

       Purpose: This property defines the revision sequence number of the
       calendar component within a sequence of revisions.

       Value Type: integer

       Property Parameters: Non-standard property parameters can be
       specified on this property.

       Conformance: The property can be specified in "VEVENT", "VTODO" or
       "VJOURNAL" calendar component.

       Description: When a calendar component is created, its sequence
       number is zero (US-ASCII decimal 48). It is monotonically incremented
       by the "Organizer's" CUA each time the "Organizer" makes a
       significant revision to the calendar component. When the "Organizer"
       makes changes to one of the following properties, the sequence number
       MUST be incremented:

         .  "DTSTART"

         .  "DTEND"

         .  "DUE"

         .  "RDATE"

         .  "RRULE"

         .  "EXDATE"

         .  "EXRULE"

         .  "STATUS"

       In addition, changes made by the "Organizer" to other properties can
       also force the sequence number to be incremented. The "Organizer" CUA
       MUST increment the sequence number when ever it makes changes to
       properties in the calendar component that the "Organizer" deems will
       jeopardize the validity of the participation status of the
       "Attendees". For example, changing the location of a meeting from one
       locale to another distant locale could effectively impact the
       participation status of the "Attendees".

       The "Organizer" includes this property in an iCalendar object that it
       sends to an "Attendee" to specify the current version of the calendar
       component.

       The "Attendee" includes this property in an iCalendar object that it
       sends to the "Organizer" to specify the version of the calendar
       component that the "Attendee" is referring to.

       A change to the sequence number is not the mechanism that an
       "Organizer" uses to request a response from the "Attendees". The
       "RSVP" parameter on the "ATTENDEE" property is used by the
       "Organizer" to indicate that a response from the "Attendees" is
       requested.

       Format Definition: This property is defined by the following
       notation:

         seq = "SEQUENCE" seqparam ":" integer CRLF
         ; Default is "0"

         seqparam   = *(";" xparam)

       Example: The following is an example of this property for a calendar
       component that was just created by the "Organizer".

         SEQUENCE:0

       The following is an example of this property for a calendar component
       that has been revised two different times by the "Organizer".

         SEQUENCE:2
Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private int
private static final long
Inherited from net.fortuna.ical4j.model.Property:
ACKNOWLEDGEDACTIONATTACHATTENDEEBUSYTYPECALENDAR_ADDRESSCALSCALECATEGORIESCLASSCOMMENTCOMPLETEDCONTACTCOUNTRYCREATEDDESCRIPTIONDTENDDTSTAMPDTSTARTDUEDURATIONEXDATEEXPERIMENTAL_PREFIXEXRULEEXTENDED_ADDRESSFREEBUSYGEOLAST_MODIFIEDLOCALITYLOCATIONLOCATION_TYPEMETHODNAMEORGANIZERPARTICIPANT_TYPEPERCENT_COMPLETEPOSTALCODEPRIORITYPRODIDPROXIMITYRDATERECURRENCE_IDREGIONRELATED_TOREPEATREQUEST_STATUSRESOURCE_TYPERESOURCESRRULESEQUENCESTATUSSTREET_ADDRESSSTRUCTURED_DATASTYLED_DESCRIPTIONSUMMARYTELTRANSPTRIGGERTZIDTZID_ALIAS_OFTZNAMETZOFFSETFROMTZOFFSETTOTZUNTILTZURLUIDURLVERSIONXML

Constructor Summary

AccessConstructor and Description
public
Sequence()

Default constructor.

public
Sequence(final String
a value string for this component
aValue
)

public
Sequence(final ParameterList
a list of parameters for this component
aList
,
final String
a value string for this component
aValue
)

public
Sequence(final int
a sequence number
aSequenceNo
)

public
Sequence(final ParameterList
a list of parameters for this component
aList
,
final int
a sequence number
aSequenceNo
)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(@NotNull Property
the object to be compared.
o
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public final int

Returns:

Returns the sequenceNo.
getSequenceNo
()

public final String
protected PropertyFactory<Sequence>
newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

public final void
setValue(final String
a string representation of the property value
aValue
)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

public ValidationResult
validate()

Implements abstract net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Inherited from net.fortuna.ical4j.model.Property:
addcompareTocopyequalsgetFluentTargetgetNamegetParametergetParametergetParameterListgetParametersgetPrefixgetRequiredParametergetRequiredParameterhashCoderemoveremoveAllreplacesetParameterssetPrefixtoString

Field Detail

sequenceNoback to summary
private int sequenceNo
serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

Constructor Detail

Sequenceback to summary
public Sequence()

Default constructor.

Sequenceback to summary
public Sequence(final String aValue)
Parameters
aValue:String

a value string for this component

Sequenceback to summary
public Sequence(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

Sequenceback to summary
public Sequence(final int aSequenceNo)
Parameters
aSequenceNo:int

a sequence number

Sequenceback to summary
public Sequence(final ParameterList aList, final int aSequenceNo)
Parameters
aList:ParameterList

a list of parameters for this component

aSequenceNo:int

a sequence number

Method Detail

compareToback to summary
public int compareTo(@NotNull Property o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
o:@NotNull Property

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
getSequenceNoback to summary
public final int getSequenceNo()
Returns:int

Returns the sequenceNo.

getValueback to summary
public final String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
newFactoryback to summary
protected PropertyFactory<Sequence> newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Doc from net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<Sequence>

a property factory instance

Annotations
@Override
setValueback to summary
public final void setValue(final String aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Doc from net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

Parameters
aValue:String

a string representation of the property value

Annotations
@Override
validateback to summary
public ValidationResult validate() throws ValidationException

Implements abstract net.fortuna.ical4j.model.Property.validate.

Doc from net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Annotations
@Override
Exceptions
ValidationException:
where the property is not in a valid state
net.fortuna.ical4j.model.property back to summary

public Class Sequence.Factory

extends Factory
implements PropertyFactory<Sequence>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Sequence
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public Sequence
Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public Sequence createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:Sequence

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public Sequence createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:Sequence

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override