net.fortuna.ical4j.model.property
Class DateProperty

java.lang.Object
  extended by net.fortuna.ical4j.model.Content
      extended by net.fortuna.ical4j.model.Property
          extended by net.fortuna.ical4j.model.property.DateProperty
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
DtEnd, DtStart, Due, RecurrenceId, UtcProperty

public abstract class DateProperty
extends Property

Base class for properties with a DATE or DATE-TIME value. Note that some sub-classes may only allow either a DATE or a DATE-TIME value, for which additional rules/validation should be specified.

Author:
Ben Fortuna
See Also:
Serialized Form

Field Summary
protected  TimeZone timezone
           
 
Fields inherited from class net.fortuna.ical4j.model.Property
ACTION, ATTACH, ATTENDEE, 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 Summary
DateProperty(java.lang.String name)
           
DateProperty(java.lang.String name, ParameterList parameters)
           
DateProperty(java.lang.String name, TimeZone timezone)
          Creates a new instance of the named property with an initial timezone.
 
Method Summary
 Property copy()
          Create a (deep) copy of this property.
 Date getDate()
           
 java.lang.String getValue()
           
 boolean isUtc()
          Indicates whether the current date value is specified in UTC time.
 void setDate(Date date)
          Sets the date value of this property.
 void setTimeZone(TimeZone timezone)
          Publically available method to update the current timezone.
 void setUtc(boolean utc)
          Resets the VTIMEZONE associated with the property.
 void setValue(java.lang.String value)
          Default setValue() implementation.
 void validate()
          Perform validation on a property.
 
Methods inherited from class net.fortuna.ical4j.model.Property
equals, getName, getParameter, getParameters, getParameters, hashCode, isCalendarProperty, isComponentProperty, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

timezone

protected TimeZone timezone
Constructor Detail

DateProperty

public DateProperty(java.lang.String name,
                    ParameterList parameters)
Parameters:
aName -
aList -

DateProperty

public DateProperty(java.lang.String name)
Parameters:
aName -

DateProperty

public DateProperty(java.lang.String name,
                    TimeZone timezone)
Creates a new instance of the named property with an initial timezone.

Parameters:
name - property name
timezone - initial timezone
Method Detail

getDate

public final Date getDate()
Returns:
Returns the date.

setDate

public final void setDate(Date date)
Sets the date value of this property. The timezone and value of this instance will also be updated accordingly.

Parameters:
date - The date to set.

setValue

public void setValue(java.lang.String value)
              throws java.text.ParseException
Default setValue() implementation. Allows for either DATE or DATE-TIME values.

Specified by:
setValue in class Property
Parameters:
value - a string representation of the property value
Throws:
java.text.ParseException - possibly thrown by setting the value of certain properties

getValue

public java.lang.String getValue()
Specified by:
getValue in class Property
Returns:
Returns the value.

setTimeZone

public void setTimeZone(TimeZone timezone)
Publically available method to update the current timezone.

Parameters:
timezone -

setUtc

public final void setUtc(boolean utc)
Resets the VTIMEZONE associated with the property. If utc is true, any TZID parameters are removed and the Java timezone is updated to UTC time. If utc is false, TZID parameters are removed and the Java timezone is set to the default timezone (i.e. represents a "floating" local time)

Parameters:
utc -

isUtc

public final boolean isUtc()
Indicates whether the current date value is specified in UTC time.

Returns:

validate

public void validate()
              throws ValidationException
Description copied from class: Property
Perform validation on a property.

Specified by:
validate in class Property
Throws:
ValidationException - where the property is not in a valid state

copy

public Property copy()
              throws java.io.IOException,
                     java.net.URISyntaxException,
                     java.text.ParseException
Description copied from class: Property
Create a (deep) copy of this property.

Overrides:
copy in class Property
Returns:
the copy of the property
Throws:
java.io.IOException
java.net.URISyntaxException
java.text.ParseException


Copyright © 2004-2007 Modularity. All Rights Reserved.