public class DtStart extends DateProperty
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
isCalendarProperty
ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION
Constructor and Description |
---|
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,
java.lang.String aValue) |
DtStart(java.lang.String aValue) |
DtStart(java.lang.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.
|
Modifier and Type | Method and Description |
---|---|
void |
validate()
Perform validation on a property.
|
copy, getDate, getTimeZone, getValue, hashCode, isUtc, setDate, setTimeZone, setUtc, setValue
equals, getName, getParameter, getParameters, getParameters, isCalendarProperty, toString
public DtStart()
public DtStart(TimeZone timezone)
timezone
- initial timezonepublic DtStart(java.lang.String aValue) throws java.text.ParseException
aValue
- a value string for this componentjava.text.ParseException
- where the specified value string is not a valid date-time/date representationpublic DtStart(java.lang.String value, TimeZone timezone) throws java.text.ParseException
value
- a string representation of a DTSTART valuetimezone
- initial timezonejava.text.ParseException
- where the specified value is not a valid string
representationpublic DtStart(ParameterList aList, java.lang.String aValue) throws java.text.ParseException
aList
- a list of parameters for this componentaValue
- a value string for this componentjava.text.ParseException
- where the specified value string is not a valid date-time/date representationpublic DtStart(Date aDate)
aDate
- a datepublic DtStart(Date time, boolean utc)
time
- the time of the DtStartutc
- specifies whether time is UTCpublic DtStart(ParameterList aList, Date aDate)
aList
- a list of parameters for this componentaDate
- a datepublic final void validate() throws ValidationException
validate
in class DateProperty
ValidationException
- where the property is not in a valid state