net.fortuna.ical4j.model.property
Class DtStart
java.lang.Object
net.fortuna.ical4j.model.Content
net.fortuna.ical4j.model.Property
net.fortuna.ical4j.model.property.DateProperty
net.fortuna.ical4j.model.property.DtStart
- All Implemented Interfaces:
- Serializable
- public class DtStart
- extends DateProperty
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
- Author:
- Ben Fortuna
- See Also:
- Serialized Form
Fields inherited from class net.fortuna.ical4j.model.Property |
ACTION, ATTACH, ATTENDEE, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, FREEBUSY, GEO, LAST_MODIFIED, LOCATION, METHOD, ORGANIZER, PERCENT_COMPLETE, PRIORITY, PRODID, RDATE, RECURRENCE_ID, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCES, RRULE, SEQUENCE, STATUS, SUMMARY, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION |
Method Summary |
void |
validate()
Perform validation on a property. |
DtStart
public DtStart()
- Default constructor. The time value is initialised to the
time of instantiation.
DtStart
public DtStart(String aValue)
throws ParseException
- Parameters:
aValue
- a value string for this component
- Throws:
ParseException
- where the specified value string is not a valid
date-time/date representation
DtStart
public DtStart(ParameterList aList,
String aValue)
throws ParseException
- Parameters:
aList
- a list of parameters for this componentaValue
- a value string for this component
- Throws:
ParseException
- where the specified value string is not a valid
date-time/date representation
DtStart
public DtStart(Date aDate)
- Constructor. Date or Date-Time format is determined based
on the presence of a VALUE parameter.
- Parameters:
aDate
- a date
DtStart
public DtStart(Date time,
boolean utc)
- Constructs a new DtStart with the specified time.
- Parameters:
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.
- Parameters:
aList
- a list of parameters for this componentaDate
- a date
validate
public final void validate()
throws ValidationException
- Description copied from class:
Property
- Perform validation on a property.
- Overrides:
validate
in class DateProperty
- Throws:
ValidationException
- See Also:
Property.validate()