michael@0: /** michael@0: * Copyright (c) 2012, Ben Fortuna michael@0: * All rights reserved. michael@0: * michael@0: * Redistribution and use in source and binary forms, with or without michael@0: * modification, are permitted provided that the following conditions michael@0: * are met: michael@0: * michael@0: * o Redistributions of source code must retain the above copyright michael@0: * notice, this list of conditions and the following disclaimer. michael@0: * michael@0: * o Redistributions in binary form must reproduce the above copyright michael@0: * notice, this list of conditions and the following disclaimer in the michael@0: * documentation and/or other materials provided with the distribution. michael@0: * michael@0: * o Neither the name of Ben Fortuna nor the names of any other contributors michael@0: * may be used to endorse or promote products derived from this software michael@0: * without specific prior written permission. michael@0: * michael@0: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS michael@0: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT michael@0: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR michael@0: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR michael@0: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, michael@0: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, michael@0: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR michael@0: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF michael@0: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING michael@0: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS michael@0: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. michael@0: */ michael@0: package net.fortuna.ical4j.model.property; michael@0: michael@0: import net.fortuna.ical4j.model.Escapable; michael@0: import net.fortuna.ical4j.model.ParameterList; michael@0: import net.fortuna.ical4j.model.Property; michael@0: import net.fortuna.ical4j.model.PropertyFactoryImpl; michael@0: import net.fortuna.ical4j.model.ValidationException; michael@0: michael@0: /** michael@0: * $Id$ michael@0: * michael@0: * Created: [Apr 6, 2004] michael@0: * michael@0: * Defines a UID iCalendar component property. michael@0: * michael@0: * 
michael@0:  *     4.8.4.7 Unique Identifier
michael@0:  *     
michael@0:  *        Property Name: UID
michael@0:  *     
michael@0:  *        Purpose: This property defines the persistent, globally unique
michael@0:  *        identifier for the calendar component.
michael@0:  *     
michael@0:  *        Value Type: TEXT
michael@0:  *     
michael@0:  *        Property Parameters: Non-standard property parameters can be
michael@0:  *        specified on this property.
michael@0:  *     
michael@0:  *        Conformance: The property MUST be specified in the "VEVENT", "VTODO",
michael@0:  *        "VJOURNAL" or "VFREEBUSY" calendar components.
michael@0:  *     
michael@0:  *        Description: The UID itself MUST be a globally unique identifier. The
michael@0:  *        generator of the identifier MUST guarantee that the identifier is
michael@0:  *        unique. There are several algorithms that can be used to accomplish
michael@0:  *        this. The identifier is RECOMMENDED to be the identical syntax to the
michael@0:  *        [RFC 822] addr-spec. A good method to assure uniqueness is to put the
michael@0:  *        domain name or a domain literal IP address of the host on which the
michael@0:  *        identifier was created on the right hand side of the "@", and on the
michael@0:  *        left hand side, put a combination of the current calendar date and
michael@0:  *        time of day (i.e., formatted in as a DATE-TIME value) along with some
michael@0:  *        other currently unique (perhaps sequential) identifier available on
michael@0:  *        the system (for example, a process id number). Using a date/time
michael@0:  *        value on the left hand side and a domain name or domain literal on
michael@0:  *        the right hand side makes it possible to guarantee uniqueness since
michael@0:  *        no two hosts should be using the same domain name or IP address at
michael@0:  *        the same time. Though other algorithms will work, it is RECOMMENDED
michael@0:  *        that the right hand side contain some domain identifier (either of
michael@0:  *        the host itself or otherwise) such that the generator of the message
michael@0:  *        identifier can guarantee the uniqueness of the left hand side within
michael@0:  *        the scope of that domain.
michael@0:  *     
michael@0:  *        This is the method for correlating scheduling messages with the
michael@0:  *        referenced "VEVENT", "VTODO", or "VJOURNAL" calendar component.
michael@0:  *     
michael@0:  *        The full range of calendar components specified by a recurrence set
michael@0:  *        is referenced by referring to just the "UID" property value
michael@0:  *        corresponding to the calendar component. The "RECURRENCE-ID" property
michael@0:  *        allows the reference to an individual instance within the recurrence
michael@0:  *        set.
michael@0:  *     
michael@0:  *        This property is an important method for group scheduling
michael@0:  *        applications to match requests with later replies, modifications or
michael@0:  *        deletion requests. Calendaring and scheduling applications MUST
michael@0:  *        generate this property in "VEVENT", "VTODO" and "VJOURNAL" calendar
michael@0:  *        components to assure interoperability with other group scheduling
michael@0:  *        applications. This identifier is created by the calendar system that
michael@0:  *        generates an iCalendar object.
michael@0:  *     
michael@0:  *        Implementations MUST be able to receive and persist values of at
michael@0:  *        least 255 characters for this property.
michael@0:  *     
michael@0:  *        Format Definition: The property is defined by the following notation:
michael@0:  *     
michael@0:  *          uid        = "UID" uidparam ":" text CRLF
michael@0:  *     
michael@0:  *          uidparam   = *(";" xparam)
michael@0:  *     
michael@0:  *        Example: The following is an example of this property:
michael@0:  *     
michael@0:  *          UID:19960401T080045Z-4000F192713-0052@host1.com
michael@0:  *
michael@0: * michael@0: * @author Ben Fortuna michael@0: */ michael@0: public class Uid extends Property implements Escapable { michael@0: michael@0: private static final long serialVersionUID = -7139407612536588584L; michael@0: michael@0: private String value; michael@0: michael@0: /** michael@0: * Default constructor. michael@0: */ michael@0: public Uid() { michael@0: super(UID, PropertyFactoryImpl.getInstance()); michael@0: } michael@0: michael@0: /** michael@0: * @param aValue a value string for this component michael@0: */ michael@0: public Uid(final String aValue) { michael@0: super(UID, PropertyFactoryImpl.getInstance()); michael@0: setValue(aValue); michael@0: } michael@0: michael@0: /** michael@0: * @param aList a list of parameters for this component michael@0: * @param aValue a value string for this component michael@0: */ michael@0: public Uid(final ParameterList aList, final String aValue) { michael@0: super(UID, aList, PropertyFactoryImpl.getInstance()); michael@0: setValue(aValue); michael@0: } michael@0: michael@0: /** michael@0: * {@inheritDoc} michael@0: */ michael@0: public final void setValue(final String aValue) { michael@0: this.value = aValue; michael@0: } michael@0: michael@0: /** michael@0: * {@inheritDoc} michael@0: */ michael@0: public final String getValue() { michael@0: return value; michael@0: } michael@0: michael@0: /** michael@0: * {@inheritDoc} michael@0: */ michael@0: public final void validate() throws ValidationException { michael@0: // TODO: Auto-generated method stub michael@0: } michael@0: }