net.fortuna.ical4j.model.component

Class VTimeZone


public class VTimeZone
extends CalendarComponent

$Id: VTimeZone.java,v 1.27 2009/01/08 14:18:32 fortuna Exp $ [Apr 5, 2004] Defines an iCalendar VTIMEZONE component.
       4.6.5 Time Zone Component
  
          Component Name: VTIMEZONE
  
          Purpose: Provide a grouping of component properties that defines a
          time zone.
  
          Formal Definition: A "VTIMEZONE" calendar component is defined by the
          following notation:
  
            timezonec  = "BEGIN" ":" "VTIMEZONE" CRLF
  
                         2*(
  
                         ; 'tzid' is required, but MUST NOT occur more
                         ; than once
  
                       tzid /
  
                         ; 'last-mod' and 'tzurl' are optional,
                       but MUST NOT occur more than once
  
                       last-mod / tzurl /
  
                         ; one of 'standardc' or 'daylightc' MUST occur
                       ..; and each MAY occur more than once.
  
                       standardc / daylightc /
  
                       ; the following is optional,
                       ; and MAY occur more than once
  
                         x-prop
  
                         )
  
                         "END" ":" "VTIMEZONE" CRLF
  
            standardc  = "BEGIN" ":" "STANDARD" CRLF
  
                         tzprop
  
                         "END" ":" "STANDARD" CRLF
  
            daylightc  = "BEGIN" ":" "DAYLIGHT" CRLF
  
                         tzprop
  
                         "END" ":" "DAYLIGHT" CRLF
  
            tzprop     = 3*(
  
                       ; the following are each REQUIRED,
                       ; but MUST NOT occur more than once
  
                       dtstart / tzoffsetto / tzoffsetfrom /
  
                       ; the following are optional,
                       ; and MAY occur more than once
  
                       comment / rdate / rrule / tzname / x-prop
  
                       )
 

Constructor Summary

VTimeZone()
Default constructor.
VTimeZone(ComponentList observances)
Constructs a new vtimezone component with no properties and the specified list of type components.
VTimeZone(PropertyList properties)
Constructs a new instance containing the specified properties.
VTimeZone(PropertyList properties, ComponentList observances)
Constructor.

Method Summary

Component
copy()
Overrides default copy method to add support for copying observance sub-components.
boolean
equals(Object arg0)
Observance
getApplicableObservance(Date date)
Returns the latest applicable timezone observance for the specified date.
LastModified
getLastModified()
ComponentList
getObservances()
TzId
getTimeZoneId()
TzUrl
getTimeZoneUrl()
int
hashCode()
String
toString()
void
validate(boolean recurse)
void
validateAdd()
void
validateCancel()
void
validateCounter()
void
validateDeclineCounter()
void
validatePublish()
void
validateRefresh()
void
validateReply()
void
validateRequest()

Constructor Details

VTimeZone

public VTimeZone()
Default constructor.

VTimeZone

public VTimeZone(ComponentList observances)
Constructs a new vtimezone component with no properties and the specified list of type components.
Parameters:
observances - a list of type components

VTimeZone

public VTimeZone(PropertyList properties)
Constructs a new instance containing the specified properties.
Parameters:
properties - a list of properties

VTimeZone

public VTimeZone(PropertyList properties,
                 ComponentList observances)
Constructor.
Parameters:
properties - a list of properties
observances - a list of timezone types

Method Details

copy

public Component copy()
            throws ParseException,
                   IOException,
                   URISyntaxException
Overrides default copy method to add support for copying observance sub-components.
See Also:
net.fortuna.ical4j.model.Component.copy()

equals

public boolean equals(Object arg0)

getApplicableObservance

public final Observance getApplicableObservance(Date date)
Returns the latest applicable timezone observance for the specified date.
Parameters:
date - the latest possible date for a timezone observance onset
Returns:
the latest applicable timezone observance for the specified date or null if there are no applicable observances

getLastModified

public final LastModified getLastModified()
Returns:
the optional last-modified property

getObservances

public final ComponentList getObservances()
Returns:
Returns the types.

getTimeZoneId

public final TzId getTimeZoneId()
Returns:
the mandatory timezone identifier property

getTimeZoneUrl

public final TzUrl getTimeZoneUrl()
Returns:
the optional timezone url property

hashCode

public int hashCode()

toString

public final String toString()
See Also:
java.lang.Object.toString()

validate

public final void validate(boolean recurse)
            throws ValidationException

validateAdd

public void validateAdd()
            throws ValidationException

validateCancel

public void validateCancel()
            throws ValidationException

validateCounter

public void validateCounter()
            throws ValidationException

validateDeclineCounter

public void validateDeclineCounter()
            throws ValidationException

validatePublish

public void validatePublish()
            throws ValidationException

validateRefresh

public void validateRefresh()
            throws ValidationException

validateReply

public void validateReply()
            throws ValidationException

validateRequest

public void validateRequest()
            throws ValidationException