biweekly.property

Class DateDue

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<ICalDate>

biweekly.property.DateOrDateTimeProperty

biweekly.property.DateDue

public class DateDue
extends DateOrDateTimeProperty

Defines the due date of a to-do task.

Code sample (creating):

 VTodo todo = new VTodo();
 
 //date and time
 Date datetime = ...
 DateDue due = new DateDue(datetime);
 todo.setDateDue(due);
 
 //date (without time component)
 Date date = ...
 due = new DateDue(date, false);
 todo.setDateDue(due);
 

Code sample (reading):

 ICalReader reader = ...
 ICalendar ical = reader.readNext();
 TimezoneInfo tzinfo = reader.getTimezoneInfo();
 
 for (VTodo todo : ical.getTodos()){
   DateDue due = todo.getDateDue();
   
   //get property value (ICalDate extends java.util.Date)
   ICalDate value = due.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(due);
 }
 

Code sample (using timezones):

 DateDue due = new DateDue(...);
 
 ICalendar ical = new ICalendar();
 VTodo todo = new VTodo();
 Date datetime = ...
 todo.setDateDue(due);
 ical.addTodo(todo);
 
 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(due, tz);
 
 //finally, write the iCalendar object
 writer.write(ical);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.96-7, RFC 2445 p.92-3, vCal 1.0 p.30

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
DateDue(Date dueDate) Creates a due date property.
DateDue(Date dueDate, boolean hasTime) Creates a due date property.
DateDue(DateDue original) Copy constructor.
DateDue(ICalDate dueDate) Creates a due date property.

Method Summary

Methods

Modifier and Type	Method and Description
DateDue	copy() Creates a copy of this property object.

Methods inherited from class biweekly.property.DateOrDateTimeProperty

setValue

Methods inherited from class biweekly.property.ValuedProperty

equals, getValue, getValue, hashCode, setValue, toStringValues, validate, valueEquals, valueHashCode

Methods inherited from class biweekly.property.ICalProperty

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DateDue

public DateDue(Date dueDate)

Creates a due date property.

Parameters:

dueDate - the due date

DateDue

public DateDue(Date dueDate,
       boolean hasTime)

Creates a due date property.

Parameters:

dueDate - the due date

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

DateDue

public DateDue(ICalDate dueDate)

Creates a due date property.

Parameters:

dueDate - the due date

DateDue

public DateDue(DateDue original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

copy

public DateDue copy()

Description copied from class: ICalProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the ICalProperty.ICalProperty(ICalProperty) super constructor to ensure that the parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the ICalendar class's copy constructor ).

Overrides:

copy in class ICalProperty

Returns:

the copy