Package net.fortuna.ical4j.model.property

Class Url

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.Url

All Implemented Interfaces:

Serializable, Comparable<Property>, FluentProperty

public class Url
extends Property

$Id$

Created: [Apr 6, 2004]

Defines a URL iCalendar component property.

     4.8.4.6 Uniform Resource Locator

        Property Name: URL

        Purpose: This property defines a Uniform Resource Locator (URL)
        associated with the iCalendar object.

        Value Type: URI

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

        Conformance: This property can be specified once in the "VEVENT",
        "VTODO", "VJOURNAL" or "VFREEBUSY" calendar components.

        Description: This property may be used in a calendar component to
        convey a location where a more dynamic rendition of the calendar
        information associated with the calendar component can be found. This
        memo does not attempt to standardize the form of the URI, nor the
        format of the resource pointed to by the property value. If the URL
        property and Content-Location MIME header are both specified, they
        MUST point to the same resource.

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

          url        = "URL" urlparam ":" uri CRLF

          urlparam   = *(";" xparam)

        Example: The following is an example of this property:

          URL:http://abc.com/pub/calendars/jsmith/mytime.ics
 

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Url.Factory

Field Summary

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

ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, 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, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION, XML

Constructor Summary

Constructors

Constructor	Description
Url()	Default constructor.
Url(URI aUri)
Url(ParameterList aList, String aValue)
Url(ParameterList aList, URI aUri)

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fortuna.ical4j.model.FluentProperty

withParameter

Constructor Details

Url

public Url()

Default constructor.

Url

public Url(ParameterList aList,
 String aValue)
    throws URISyntaxException

Parameters:

aList - a list of parameters for this component

aValue - a value string for this component

Throws:

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

Url

public Url(URI aUri)

Parameters:

aUri - a URI

Url

public Url(ParameterList aList,
 URI aUri)

Parameters:

aList - a list of parameters for this component

aUri - a URI

Method Details

getUri

public final URI getUri()

Returns:

Returns the uri.

setValue

public final void setValue(String aValue)
                    throws URISyntaxException

Sets the current value of the property.

Specified by:

setValue in class Property

Parameters:

aValue - a string representation of the property value

Throws:

URISyntaxException - possibly thrown by setting the value of certain properties

getValue

public final String getValue()

Specified by:

getValue in class Content

Returns:

the content value

setUri

public final void setUri(URI uri)

Parameters:

uri - The uri to set.

validate

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