biweekly.property
Class DateOrDateTimeProperty

java.lang.Object
  biweekly.property.ICalProperty
      biweekly.property.DateOrDateTimeProperty

Direct Known Subclasses:

DateDue, DateEnd, DateStart, RecurrenceId

public class DateOrDateTimeProperty
extends ICalProperty

Represents a property whose value is a date or a date-time.

Author:

Michael Angstadt

Field Summary

protected boolean	hasTime
protected Date	value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

DateOrDateTimeProperty(Date value, boolean hasTime)
Creates a new property.

Method Summary

String	getTimezoneId() Gets the timezone identifier.
Date	getValue() Gets the date.
boolean	hasTime() Determines whether the date has a time component.
void	setTimezone(VTimezone timezone) Sets the property's timezone to a timezone that is defined within the iCalendar object.
void	setTimezoneId(String timezoneId) Sets the property's timezone in the form of a globally-defined timezone (e.g.
void	setValue(Date value, boolean hasTime) Sets the date.
protected void	validate(List<ICalComponent> components, List<String> warnings) Checks the property for data consistency problems or deviations from the spec.

Methods inherited from class biweekly.property.ICalProperty

addParameter, getAltRepresentation, getCommonName, getDirectoryEntry, getFormatType, getLanguage, getParameter, getParameters, getParameters, getSentBy, removeParameter, setAltRepresentation, setCommonName, setDirectoryEntry, setFormatType, setLanguage, setParameter, setParameter, setParameters, setSentBy, validate

Methods inherited from class java.lang.Object

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

Field Detail

value

protected Date value

hasTime

protected boolean hasTime

Constructor Detail

DateOrDateTimeProperty

public DateOrDateTimeProperty(Date value,
                              boolean hasTime)

Creates a new property.

Parameters:

value - the date

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

Method Detail

getValue

public Date getValue()

Gets the date.

Returns:

the date

setValue

public void setValue(Date value,
                     boolean hasTime)

Sets the date.

Parameters:

value - the date

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

hasTime

public boolean hasTime()

Determines whether the date has a time component.

Returns:

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

getTimezoneId

public String getTimezoneId()

Description copied from class: ICalProperty

Gets the timezone identifier. This either (a) references the TimezoneId property of a VTimezone component, or (b) specifies a globally-defined timezone (e.g. "America/New_York"). For a list of globally-defined timezones, see the TZ database.

Overrides:

getTimezoneId in class ICalProperty

Returns:

the timezone identifier or null if not set

See Also:

RFC 5545 p.27-8

setTimezoneId

public void setTimezoneId(String timezoneId)

Description copied from class: ICalProperty

Sets the property's timezone in the form of a globally-defined timezone (e.g. "America/New_York"). For a list of globally-defined timezones, see the TZ database. Use ICalProperty.setTimezone(VTimezone) to use a timezone that's defined within the iCalendar object.

Overrides:

setTimezoneId in class ICalProperty

Parameters:

timezoneId - the timezone identifier (e.g. "America/New_York") or null to remove

See Also:

RFC 5545 p.27-8

setTimezone

public void setTimezone(VTimezone timezone)

Description copied from class: ICalProperty

Sets the property's timezone to a timezone that is defined within the iCalendar object. Use ICalProperty.setTimezoneId(String) to use a globally-defined timezone (e.g. "America/New_York").

Overrides:

setTimezone in class ICalProperty

Parameters:

timezone - the timezone component or null to remove

See Also:

RFC 5545 p.27-8

validate

protected void validate(List<ICalComponent> components,
                        List<String> warnings)

Description copied from class: ICalProperty

Checks the property for data consistency problems or deviations from the spec. Meant to be overridden by child classes.

Overrides:

validate in class ICalProperty

Parameters:

components - the hierarchy of components that the property belongs to

warnings - the list to add the warnings to