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

public Class DtStamp

extends DateProperty<Instant>
implements UtcProperty
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.property.UtcProperty
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.model.parameter.Value, net.fortuna.ical4j.util.CompatibilityHints, org.jetbrains.annotations.NotNull, java.time.Instant, .ZoneId

$Id$

Created: [Apr 6, 2004]

Defines a DTSTAMP iCalendar component property.

    4.8.7.2 Date/Time Stamp

       Property Name: DTSTAMP

       Purpose: The property indicates the date/time that the instance of
       the iCalendar object was created.

       Value Type: DATE-TIME

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

       Conformance: This property MUST be included in the "VEVENT", "VTODO",
       "VJOURNAL" or "VFREEBUSY" calendar components.

       Description: The value MUST be specified in the UTC time format.

       This property is also useful to protocols such as [IMIP] that have
       inherent latency issues with the delivery of content. This property
       will assist in the proper sequencing of messages containing iCalendar
       objects.

       This property is different than the "CREATED" and "LAST-MODIFIED"
       properties. These two properties are used to specify when the
       particular calendar data in the calendar store was created and last
       modified. This is different than when the iCalendar object
       representation of the calendar service information was created or
       last modified.

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

         dtstamp    = "DTSTAMP" stmparam ":" date-time CRLF

         stmparam   = *(";" xparam)
Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public
DtStamp()

Default constructor.

public
DtStamp(final String
a string representation of a DTSTAMP value
aValue
)

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

public
DtStamp(final Instant
a date representing a date-time
aDate
)

public
DtStamp(final ParameterList
a list of parameters for this component
aList
,
final Instant
a date representing a date-time
aDate
)

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.

protected PropertyFactory<DtStamp>
newFactory()

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

Returns a new property factory used to create deep copies.

public void
setDefaultTimeZone(ZoneId
a timezone identifier
defaultTimeZone
)

Overrides net.fortuna.ical4j.model.property.DateProperty.setDefaultTimeZone.

Overrides default net.fortuna.ical4j.model.property.UtcProperty.setDefaultTimeZone.

A default timezone may be specified for interpreting floating DATE-TIME values.

public void
Inherited from net.fortuna.ical4j.model.property.DateProperty:
compareTogetDategetValuehashCodeisUtcrefreshParameterssetDatesetValuevalidate

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.property.DateProperty.serialVersionUID.

Constructor Detail

DtStampback to summary
public DtStamp()

Default constructor. Initialises the dateTime value to the time of instantiation.

DtStampback to summary
public DtStamp(final String aValue)
Parameters
aValue:String

a string representation of a DTSTAMP value

DtStampback to summary
public DtStamp(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

DtStampback to summary
public DtStamp(final Instant aDate)
Parameters
aDate:Instant

a date representing a date-time

DtStampback to summary
public DtStamp(final ParameterList aList, final Instant aDate)
Parameters
aList:ParameterList

a list of parameters for this component

aDate:Instant

a date representing a date-time

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
newFactoryback to summary
protected PropertyFactory<DtStamp> 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<DtStamp>

a property factory instance

Annotations
@Override
setDefaultTimeZoneback to summary
public void setDefaultTimeZone(ZoneId defaultTimeZone)

Overrides net.fortuna.ical4j.model.property.DateProperty.setDefaultTimeZone.

Overrides default net.fortuna.ical4j.model.property.UtcProperty.setDefaultTimeZone.

Doc from net.fortuna.ical4j.model.property.DateProperty.setDefaultTimeZone.

A default timezone may be specified for interpreting floating DATE-TIME values. In the absence of a default timezone the system default timezone will be used.

Parameters
defaultTimeZone:ZoneId

a timezone identifier

Annotations
@Override
setTimeZoneRegistryback to summary
public void setTimeZoneRegistry(TimeZoneRegistry timeZoneRegistry)

Overrides net.fortuna.ical4j.model.property.DateProperty.setTimeZoneRegistry.

Overrides default net.fortuna.ical4j.model.property.UtcProperty.setTimeZoneRegistry.

Annotations
@Override
net.fortuna.ical4j.model.property back to summary

public Class DtStamp.Factory

extends Factory
implements PropertyFactory<DtStamp>
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 DtStamp
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

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

public DtStamp
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 DtStamp 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:DtStamp

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

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public DtStamp createProperty()

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

Returns:DtStamp

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

a new instance of the specified property

Annotations
@Override