Module ical4j.core

Class Url

All Implemented Interfaces:
Serializable, Comparable<Property>, FluentProperty, Prototype<Property>

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:
  • Constructor Details

    • Url

      public Url()
      Default constructor.
    • Url

      public Url(ParameterList aList, String aValue)
      Parameters:
      aList - a list of parameters for this component
      aValue - a value string for this component
    • 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)
      Sets the current value of the property.
      Specified by:
      setValue in class Property
      Parameters:
      aValue - a string representation of the property value
    • 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
    • newFactory

      protected PropertyFactory<Url> newFactory()
      Description copied from class: Property
      Returns a new property factory used to create deep copies.
      Specified by:
      newFactory in class Property
      Returns:
      a property factory instance