biweekly.property

Class DateEnd

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<ICalDate>

biweekly.property.DateOrDateTimeProperty

biweekly.property.DateEnd

public class DateEnd
extends DateOrDateTimeProperty

Defines the end date of an event or free/busy component.

Code sample (creating):

 VEvent event = new VEvent();
 
 //date and time
 Date datetime = ...
 DateEnd dtend = new DateEnd(datetime);
 event.setDateEnd(dtend);
 
 //date (without time component)
 Date date = ...
 dtend = new DateEnd(date, false);
 event.setDateEnd(dtend);
 

Code sample (reading):

 ICalendar ical = ...
 for (VEvent event : ical.getEvents()){
   DateEnd dtend = event.getDateEnd();
   
   //get property value (ICalDate extends java.util.Date)
   ICalDate value = dtend.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(dtend);
 }
 

Code sample (using timezones):

 ICalendar ical = new ICalendar();
 VEvent event = new VEvent();
 Date datetime = ...
 DateEnd dtend = new DateEnd(datetime);
 event.setDateEnd(dtend);
 ical.addEvent(event);
 
 TimezoneAssignment tz = ...
 
 //set the timezone of all date-time property values
 //date-time property values are written in UTC by default
 ical.getTimezoneInfo().setDefaultTimezone(tz);
 
 //or set the timezone just for this property
 ical.getTimezoneInfo().setTimezone(dtend, tz);
 
 //finally, write the iCalendar object
 ICalWriter writer = ...
 writer.write(ical);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.95-6, RFC 2445 p.91-2, vCal 1.0 p.31

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
DateEnd(Date endDate) Creates an end date property.
DateEnd(Date endDate, boolean hasTime) Creates an end date property.
DateEnd(DateEnd original) Copy constructor.
DateEnd(ICalDate dateEnd) Creates an end date property.

Method Summary

Methods

Modifier and Type	Method and Description
DateEnd	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

DateEnd

public DateEnd(Date endDate)

Creates an end date property.

Parameters:

endDate - the end date

DateEnd

public DateEnd(Date endDate,
       boolean hasTime)

Creates an end date property.

Parameters:

endDate - the end date

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

DateEnd

public DateEnd(ICalDate dateEnd)

Creates an end date property.

Parameters:

dateEnd - the end date

DateEnd

public DateEnd(DateEnd original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

copy

public DateEnd 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