$Id$

Created: [Apr 6, 2004]

Defines a DTSTART iCalendar component property.

    4.8.2.4 Date/Time Start

       Property Name: DTSTART

       Purpose: This property specifies when the calendar component begins.

       Value Type: The default value type is DATE-TIME. The time value MUST
       be one of the forms defined for the DATE-TIME value type. The value
       type can be set to a DATE value type.

       Property Parameters: Non-standard, value data type, time zone
       identifier property parameters can be specified on this property.

       Conformance: This property can be specified in the "VEVENT", "VTODO",
       "VFREEBUSY", or "VTIMEZONE" calendar components.

       Description: Within the "VEVENT" calendar component, this property
       defines the start date and time for the event. The property is
       REQUIRED in "VEVENT" calendar components. Events can have a start
       date/time but no end date/time. In that case, the event does not take
       up any time.

       Within the "VFREEBUSY" calendar component, this property defines the
       start date and time for the free or busy time information. The time
       MUST be specified in UTC time.

       Within the "VTIMEZONE" calendar component, this property defines the
       effective start date and time for a time zone specification. This
       property is REQUIRED within each STANDARD and DAYLIGHT part included
       in "VTIMEZONE" calendar components and MUST be specified as a local
       DATE-TIME without the "TZID" property parameter.

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

         dtstart    = "DTSTART" dtstparam ":" dtstval CRLF

         dtstparam  = *(

                    ; the following are optional,
                    ; but MUST NOT occur more than once

                    (";" "VALUE" "=" ("DATE-TIME" / "DATE")) /
                    (";" tzidparam) /

                    ; the following is optional,
                    ; and MAY occur more than once

                      *(";" xparam)

                    )



         dtstval    = date-time / date
         ;Value MUST match value type

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	DtStart.Factory<T extends Temporal>

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides net.fortuna.ical4j.model.property.DateProperty.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	DtStart() Default constructor.
public	DtStart(final String a value string for this component aValue)
public	DtStart(final ParameterList a list of parameters for this component aList, final String a value string for this component aValue)
public	DtStart(final T a date aDate) Constructor.
public	DtStart(final T the time of the DtStart time, final boolean specifies whether time is UTC utc) Deprecated UTC time is now specified via the generic type (i.e. `java.time.Instant`) Constructs a new DtStart with the specified time.
public	DtStart(final ParameterList a list of parameters for this component aList, final T a date aDate) Constructor.

Method Summary

Modifier and Type	Method and Description
protected PropertyFactory<DtStart<T>>	newFactory() Implements abstract net.fortuna.ical4j.model.Property.newFactory. Returns a new property factory used to create deep copies.

Inherited from net.fortuna.ical4j.model.property.DateProperty:: compareTo getDate getValue hashCode isUtc refreshParameters setDate setDefaultTimeZone setTimeZoneRegistry setValue validate

serialVersionUID	back to summary
private static final long serialVersionUID Hides net.fortuna.ical4j.model.property.DateProperty.serialVersionUID.

Constructor Detail

DtStart	back to summary
public DtStart() Default constructor. The time value is initialised to the time of instantiation.

DtStart	back to summary
public DtStart(final String aValue) Parameters aValue:String a value string for this component Exceptions DateTimeParseException: where the specified value string is not a valid date-time/date representation

DtStart	back to summary
public DtStart(final ParameterList aList, final String aValue) Parameters aList:ParameterList a list of parameters for this component aValue:String a value string for this component Exceptions DateTimeParseException: where the specified value string is not a valid date-time/date representation

DtStart	back to summary
public DtStart(final T aDate) Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter. Parameters aDate:T a date

DtStart

back to summary

public DtStart(final T aDate)

Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.

Parameters

aDate:T: a date

DtStart back to summary

DtStart	back to summary
public DtStart(final T time, final boolean utc) Deprecated UTC time is now specified via the generic type (i.e. `java.time.Instant`) Constructs a new DtStart with the specified time. Parameters time:T the time of the DtStart utc:boolean specifies whether time is UTC Annotations @Deprecated

public DtStart(final T time, final boolean utc)

Deprecated

UTC time is now specified via the generic type (i.e. java.time.Instant)

Constructs a new DtStart with the specified time.

Parameters

time:T: the time of the DtStart
utc:boolean: specifies whether time is UTC

Annotations

@Deprecated

DtStart	back to summary
public DtStart(final ParameterList aList, final T aDate) Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter. Parameters aList:ParameterList a list of parameters for this component aDate:T a date

DtStart

back to summary

public DtStart(final ParameterList aList, final T aDate)

Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.

Parameters

aList:ParameterList: a list of parameters for this component
aDate:T: a date

newFactory	back to summary
protected PropertyFactory<DtStart<T>> 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<DtStart<T>> a property factory instance Annotations @Override

net.fortuna.ical4j.model.property back to summary

public Class DtStart.Factory<T extends Temporal>

Class Inheritance

extends Factory
implements PropertyFactory<DtStart<T extends Temporal>>

java.lang.Object
net.fortuna.ical4j.model.Content.Factory
net.fortuna.ical4j.model.property.DtStart.Factory

All Implemented Interfaces

net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	Factory()

Method Summary

Modifier and Type	Method and Description
public DtStart<T>	createProperty(final ParameterList a list of property parameters parameters, final String a property value value) Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.
public DtStart<T>	createProperty() Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

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

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

Factory	back to summary
public Factory()

Method Detail

createProperty	back to summary
public DtStart<T> 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:DtStart<T> Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty. a new instance of the specified property Annotations @Override

createProperty

back to summary

public DtStart<T> 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:DtStart<T>

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

a new instance of the specified property

Annotations

@Override

createProperty	back to summary
public DtStart<T> createProperty() Implements net.fortuna.ical4j.model.PropertyFactory.createProperty. Returns:DtStart<T> Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty. a new instance of the specified property Annotations @Override

createProperty

back to summary

public DtStart<T> createProperty()

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

Returns:DtStart<T>

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

a new instance of the specified property

Annotations

@Override

public Class DtStart<T extends Temporal>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class DtStart.Factory<T extends Temporal>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail