net.fortuna.ical4j.model.property

Class TzUrl

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.TzUrl

All Implemented Interfaces:

java.io.Serializable

public class TzUrl
extends Property

$Id$

Created: [Apr 6, 2004]

Defines a TZURL iCalendar component property.

     4.8.3.5 Time Zone URL

        Property Name: TZURL

        Purpose: The TZURL provides a means for a VTIMEZONE component to
        point to a network location that can be used to retrieve an up-to-
        date version of itself.

        Value Type: URI

        Property Parameters: Non-standard property parameters can be
        specified on this property.

        Conformance: This property can be specified in a "VTIMEZONE" calendar
        component.

        Description: The TZURL provides a means for a VTIMEZONE component to
        point to a network location that can be used to retrieve an up-to-
        date version of itself. This provides a hook to handle changes
        government bodies impose upon time zone definitions. Retrieval of
        this resource results in an iCalendar object containing a single
        VTIMEZONE component and a METHOD property set to PUBLISH.

        Format Definition: The property is defined by the following notation:

          tzurl      = "TZURL" tzurlparam ":" uri CRLF

          tzurlparam = *(";" xparam)

        Example: The following is an example of this property:

          TZURL:http://timezones.r.us.net/tz/US-California-Los_Angeles
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TzUrl.Factory

Field Summary

Fields inherited from class net.fortuna.ical4j.model.Property

ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, 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

Constructors

Constructor and Description
TzUrl() Default constructor.
TzUrl(ParameterList aList, java.lang.String aValue)
TzUrl(ParameterList aList, java.net.URI aUri)
TzUrl(java.net.URI aUri)

Method Summary

Modifier and Type	Method and Description
java.net.URI	getUri()
java.lang.String	getValue()
void	setUri(java.net.URI uri)
void	setValue(java.lang.String aValue) Sets the current value of the property.
void	validate() Perform validation on a property.

Methods inherited from class net.fortuna.ical4j.model.Property

copy, equals, getName, getParameter, getParameters, getParameters, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TzUrl

public TzUrl()

Default constructor.

TzUrl

public TzUrl(ParameterList aList,
             java.lang.String aValue)
      throws java.net.URISyntaxException

Parameters:

aList - a list of parameters for this component

aValue - a value string for this component

Throws:

java.net.URISyntaxException - where the specified value string is not a valid uri

TzUrl

public TzUrl(java.net.URI aUri)

Parameters:

aUri - a URI

TzUrl

public TzUrl(ParameterList aList,
             java.net.URI aUri)

Parameters:

aList - a list of parameters for this component

aUri - a URI

Method Detail

getUri

public final java.net.URI getUri()

Returns:

Returns the uri.

setValue

public final void setValue(java.lang.String aValue)
                    throws java.net.URISyntaxException

Sets the current value of the property.

Specified by:

setValue in class Property

Parameters:

aValue - a string representation of the property value

Throws:

java.net.URISyntaxException - possibly thrown by setting the value of certain properties

getValue

public final java.lang.String getValue()

Specified by:

getValue in class Content

Returns:

the content value

setUri

public final void setUri(java.net.URI uri)

Parameters:

uri - The uri to set.

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