net.fortuna.ical4j.model.property
Class DtStart
DateProperty
net.fortuna.ical4j.model.property.DtStart
public class DtStart
extends DateProperty
$Id: DtStart.java,v 1.19 2008/12/16 12:34:51 fortuna Exp $
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
DtStart() - Default constructor.
|
DtStart(Date aDate) - Constructor.
|
DtStart(Date time, boolean utc) - Constructs a new DtStart with the specified time.
|
DtStart(ParameterList aList, Date aDate) - Constructor.
|
DtStart(ParameterList aList, String aValue)
|
DtStart(String aValue)
|
DtStart(String value, TimeZone timezone) - Creates a new DTSTART property initialised with the specified timezone and value.
|
DtStart(TimeZone timezone) - Creates a new DTSTART property initialised with the specified timezone.
|
DtStart
public DtStart()
Default constructor. The time value is initialised to the time of instantiation.
DtStart
public DtStart(Date aDate)
Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
DtStart
public DtStart(Date time,
boolean utc)
Constructs a new DtStart with the specified time.
time
- the time of the DtStartutc
- specifies whether time is UTC
DtStart
public DtStart(ParameterList aList,
Date aDate)
Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
aList
- a list of parameters for this componentaDate
- a date
DtStart
public DtStart(ParameterList aList,
String aValue)
throws ParseException
aList
- a list of parameters for this componentaValue
- a value string for this component
DtStart
public DtStart(String aValue)
throws ParseException
aValue
- a value string for this component
DtStart
public DtStart(String value,
TimeZone timezone)
throws ParseException
Creates a new DTSTART property initialised with the specified timezone and value.
value
- a string representation of a DTSTART valuetimezone
- initial timezone
DtStart
public DtStart(TimeZone timezone)
Creates a new DTSTART property initialised with the specified timezone.
timezone
- initial timezone
validate
public final void validate()
throws ValidationException