Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.property

public Class Url

extends Property
Class Inheritance
Imports
net.fortuna.ical4j.model.Content, .ParameterList, .Property, .PropertyFactory, net.fortuna.ical4j.util.Strings, .Uris, net.fortuna.ical4j.validate.ValidationException, .ValidationResult, net.fortuna.ical4j.validate.property.RelationshipPropertyValidators, java.net.URI, .URISyntaxException

$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
Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private static final long
private URI
Inherited from net.fortuna.ical4j.model.Property:
ACKNOWLEDGEDACTIONATTACHATTENDEEBUSYTYPECALENDAR_ADDRESSCALSCALECATEGORIESCLASSCOMMENTCOMPLETEDCONTACTCOUNTRYCREATEDDESCRIPTIONDTENDDTSTAMPDTSTARTDUEDURATIONEXDATEEXPERIMENTAL_PREFIXEXRULEEXTENDED_ADDRESSFREEBUSYGEOLAST_MODIFIEDLOCALITYLOCATIONLOCATION_TYPEMETHODNAMEORGANIZERPARTICIPANT_TYPEPERCENT_COMPLETEPOSTALCODEPRIORITYPRODIDPROXIMITYRDATERECURRENCE_IDREGIONRELATED_TOREPEATREQUEST_STATUSRESOURCE_TYPERESOURCESRRULESEQUENCESTATUSSTREET_ADDRESSSTRUCTURED_DATASTYLED_DESCRIPTIONSUMMARYTELTRANSPTRIGGERTZIDTZID_ALIAS_OFTZNAMETZOFFSETFROMTZOFFSETTOTZUNTILTZURLUIDURLVERSIONXML

Constructor Summary

AccessConstructor and Description
public
Url()

Default constructor.

public
Url(final ParameterList
a list of parameters for this component
aList
,
final String
a value string for this component
aValue
)

public
Url(final URI
a URI
aUri
)

public
Url(final ParameterList
a list of parameters for this component
aList
,
final URI
a URI
aUri
)

Method Summary

Modifier and TypeMethod and Description
public final URI

Returns:

Returns the uri.
getUri
()

public final String
protected PropertyFactory<Url>
newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

public final void
setUri(final URI
The uri to set.
uri
)

public final void
setValue(final String
a string representation of the property value
aValue
)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

public ValidationResult
validate()

Implements abstract net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Inherited from net.fortuna.ical4j.model.Property:
addcompareTocopyequalsgetFluentTargetgetNamegetParametergetParametergetParameterListgetParametersgetPrefixgetRequiredParametergetRequiredParameterhashCoderemoveremoveAllreplacesetParameterssetPrefixtoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

uriback to summary
private URI uri

Constructor Detail

Urlback to summary
public Url()

Default constructor.

Urlback to summary
public Url(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

Urlback to summary
public Url(final URI aUri)
Parameters
aUri:URI

a URI

Urlback to summary
public Url(final ParameterList aList, final URI aUri)
Parameters
aList:ParameterList

a list of parameters for this component

aUri:URI

a URI

Method Detail

getUriback to summary
public final URI getUri()
Returns:URI

Returns the uri.

getValueback to summary
public final String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
newFactoryback to summary
protected PropertyFactory<Url> newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Doc from net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<Url>

a property factory instance

Annotations
@Override
setUriback to summary
public final void setUri(final URI uri)
Parameters
uri:URI

The uri to set.

setValueback to summary
public final void setValue(final String aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Doc from net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

Parameters
aValue:String

a string representation of the property value

Annotations
@Override
validateback to summary
public ValidationResult validate() throws ValidationException

Implements abstract net.fortuna.ical4j.model.Property.validate.

Doc from net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Annotations
@Override
Exceptions
ValidationException:
where the property is not in a valid state
net.fortuna.ical4j.model.property back to summary

public Class Url.Factory

extends Factory
implements PropertyFactory<Url>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Url
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public Url
Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public Url createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:Url

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public Url createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:Url

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override