biweekly.property

Class DateStart

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<ICalDate>

biweekly.property.DateOrDateTimeProperty

biweekly.property.DateStart

public class DateStart
extends DateOrDateTimeProperty

Defines the start date of an event, free/busy component, or timezone component.

Code sample (creating):

 VEvent event = new VEvent();
 
 //date and time
 Date datetime = ...
 DateStart dtstart = new DateStart(datetime);
 event.setDateStart(dtstart);
 
 //date (without time component)
 Date date = ...
 dtstart = new DateStart(date, false);
 event.setDateStart(dtstart);
 

Code sample (reading):

 ICalendar ical = ...
 for (VEvent event : ical.getEvents()){
   DateStart dtstart = event.getDateStart();
   
   //get property value (ICalDate extends java.util.Date)
   ICalDate value = dtstart.getValue();
   
   if (value.hasTime()){
     //the value includes a time component
   } else {
     //the value is just a date
     //date object's time is set to "00:00:00" under local computer's default timezone
   }
   
   //gets the timezone that the property value was parsed under if you are curious about that
   TimeZone tz = tzinfo.getTimeZone(dtstart);
 }
 

Code sample (using timezones):

 DateStart dtstart = new DateStart(...);
 
 ICalendar ical = new ICalendar();
 VEvent event = new VEvent();
 event.setDateStart(dtstart);
 ical.addEvent(event);
 
 java.util.TimeZone tz = ...
 ICalWriter writer = new ICalWriter(...);
 
 //set the timezone of all date-time property values
 //date-time property values are written in UTC by default
 writer.getTimezoneInfo().setDefaultTimeZone(tz);
 
 //set the timezone just for this property
 writer.getTimezoneInfo().setTimeZone(dtstart, tz);
 
 //finally, write the iCalendar object
 writer.write(ical);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.97-8, RFC 2445 p.93-4, vCal 1.0 p.35

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
DateStart(Date startDate) Creates a start date property.
DateStart(Date startDate, boolean hasTime) Creates a start date property.
DateStart(ICalDate startDate) Creates a start date property.

Method Summary

Methods inherited from class biweekly.property.DateOrDateTimeProperty

setValue

Methods inherited from class biweekly.property.ValuedProperty

getValue, getValue, setValue, validate

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DateStart

public DateStart(Date startDate)

Creates a start date property.

Parameters:

startDate - the start date

DateStart

public DateStart(Date startDate,
         boolean hasTime)

Creates a start date property.

Parameters:

startDate - the start date

hasTime - true if the value has a time component, false if it is strictly a date

DateStart

public DateStart(ICalDate startDate)

Creates a start date property.

Parameters:

startDate - the start date