1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/net/fortuna/ical4j/model/property/Uid.java Tue Feb 10 18:12:00 2015 +0100
1.3 @@ -0,0 +1,166 @@
1.4 +/**
1.5 + * Copyright (c) 2012, Ben Fortuna
1.6 + * All rights reserved.
1.7 + *
1.8 + * Redistribution and use in source and binary forms, with or without
1.9 + * modification, are permitted provided that the following conditions
1.10 + * are met:
1.11 + *
1.12 + * o Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * o Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * o Neither the name of Ben Fortuna nor the names of any other contributors
1.20 + * may be used to endorse or promote products derived from this software
1.21 + * without specific prior written permission.
1.22 + *
1.23 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1.24 + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1.25 + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1.26 + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
1.27 + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
1.28 + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
1.29 + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
1.30 + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
1.31 + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
1.32 + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
1.33 + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.34 + */
1.35 +package net.fortuna.ical4j.model.property;
1.36 +
1.37 +import net.fortuna.ical4j.model.Escapable;
1.38 +import net.fortuna.ical4j.model.ParameterList;
1.39 +import net.fortuna.ical4j.model.Property;
1.40 +import net.fortuna.ical4j.model.PropertyFactoryImpl;
1.41 +import net.fortuna.ical4j.model.ValidationException;
1.42 +
1.43 +/**
1.44 + * $Id$
1.45 + *
1.46 + * Created: [Apr 6, 2004]
1.47 + *
1.48 + * Defines a UID iCalendar component property.
1.49 + *
1.50 + * <pre>
1.51 + * 4.8.4.7 Unique Identifier
1.52 + *
1.53 + * Property Name: UID
1.54 + *
1.55 + * Purpose: This property defines the persistent, globally unique
1.56 + * identifier for the calendar component.
1.57 + *
1.58 + * Value Type: TEXT
1.59 + *
1.60 + * Property Parameters: Non-standard property parameters can be
1.61 + * specified on this property.
1.62 + *
1.63 + * Conformance: The property MUST be specified in the "VEVENT", "VTODO",
1.64 + * "VJOURNAL" or "VFREEBUSY" calendar components.
1.65 + *
1.66 + * Description: The UID itself MUST be a globally unique identifier. The
1.67 + * generator of the identifier MUST guarantee that the identifier is
1.68 + * unique. There are several algorithms that can be used to accomplish
1.69 + * this. The identifier is RECOMMENDED to be the identical syntax to the
1.70 + * [RFC 822] addr-spec. A good method to assure uniqueness is to put the
1.71 + * domain name or a domain literal IP address of the host on which the
1.72 + * identifier was created on the right hand side of the "@", and on the
1.73 + * left hand side, put a combination of the current calendar date and
1.74 + * time of day (i.e., formatted in as a DATE-TIME value) along with some
1.75 + * other currently unique (perhaps sequential) identifier available on
1.76 + * the system (for example, a process id number). Using a date/time
1.77 + * value on the left hand side and a domain name or domain literal on
1.78 + * the right hand side makes it possible to guarantee uniqueness since
1.79 + * no two hosts should be using the same domain name or IP address at
1.80 + * the same time. Though other algorithms will work, it is RECOMMENDED
1.81 + * that the right hand side contain some domain identifier (either of
1.82 + * the host itself or otherwise) such that the generator of the message
1.83 + * identifier can guarantee the uniqueness of the left hand side within
1.84 + * the scope of that domain.
1.85 + *
1.86 + * This is the method for correlating scheduling messages with the
1.87 + * referenced "VEVENT", "VTODO", or "VJOURNAL" calendar component.
1.88 + *
1.89 + * The full range of calendar components specified by a recurrence set
1.90 + * is referenced by referring to just the "UID" property value
1.91 + * corresponding to the calendar component. The "RECURRENCE-ID" property
1.92 + * allows the reference to an individual instance within the recurrence
1.93 + * set.
1.94 + *
1.95 + * This property is an important method for group scheduling
1.96 + * applications to match requests with later replies, modifications or
1.97 + * deletion requests. Calendaring and scheduling applications MUST
1.98 + * generate this property in "VEVENT", "VTODO" and "VJOURNAL" calendar
1.99 + * components to assure interoperability with other group scheduling
1.100 + * applications. This identifier is created by the calendar system that
1.101 + * generates an iCalendar object.
1.102 + *
1.103 + * Implementations MUST be able to receive and persist values of at
1.104 + * least 255 characters for this property.
1.105 + *
1.106 + * Format Definition: The property is defined by the following notation:
1.107 + *
1.108 + * uid = "UID" uidparam ":" text CRLF
1.109 + *
1.110 + * uidparam = *(";" xparam)
1.111 + *
1.112 + * Example: The following is an example of this property:
1.113 + *
1.114 + * UID:19960401T080045Z-4000F192713-0052@host1.com
1.115 + * </pre>
1.116 + *
1.117 + * @author Ben Fortuna
1.118 + */
1.119 +public class Uid extends Property implements Escapable {
1.120 +
1.121 + private static final long serialVersionUID = -7139407612536588584L;
1.122 +
1.123 + private String value;
1.124 +
1.125 + /**
1.126 + * Default constructor.
1.127 + */
1.128 + public Uid() {
1.129 + super(UID, PropertyFactoryImpl.getInstance());
1.130 + }
1.131 +
1.132 + /**
1.133 + * @param aValue a value string for this component
1.134 + */
1.135 + public Uid(final String aValue) {
1.136 + super(UID, PropertyFactoryImpl.getInstance());
1.137 + setValue(aValue);
1.138 + }
1.139 +
1.140 + /**
1.141 + * @param aList a list of parameters for this component
1.142 + * @param aValue a value string for this component
1.143 + */
1.144 + public Uid(final ParameterList aList, final String aValue) {
1.145 + super(UID, aList, PropertyFactoryImpl.getInstance());
1.146 + setValue(aValue);
1.147 + }
1.148 +
1.149 + /**
1.150 + * {@inheritDoc}
1.151 + */
1.152 + public final void setValue(final String aValue) {
1.153 + this.value = aValue;
1.154 + }
1.155 +
1.156 + /**
1.157 + * {@inheritDoc}
1.158 + */
1.159 + public final String getValue() {
1.160 + return value;
1.161 + }
1.162 +
1.163 + /**
1.164 + * {@inheritDoc}
1.165 + */
1.166 + public final void validate() throws ValidationException {
1.167 + // TODO: Auto-generated method stub
1.168 + }
1.169 +}
