src/net/fortuna/ical4j/model/property/Uid.java@fb9019fb1bf7 (annotated)
src/net/fortuna/ical4j/model/property/Uid.java
Tue, 10 Feb 2015 18:12:00 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Tue, 10 Feb 2015 18:12:00 +0100
- changeset 0
- fb9019fb1bf7
- permissions
- -rw-r--r--
Import initial revisions of existing project AndroidCaldavSyncAdapater,
forked from upstream repository at 27e8a0f8495c92e0780d450bdf0c7cec77a03a55.
| michael@0 | 1 | /** |
| michael@0 | 2 | * Copyright (c) 2012, Ben Fortuna |
| michael@0 | 3 | * All rights reserved. |
| michael@0 | 4 | * |
| michael@0 | 5 | * Redistribution and use in source and binary forms, with or without |
| michael@0 | 6 | * modification, are permitted provided that the following conditions |
| michael@0 | 7 | * are met: |
| michael@0 | 8 | * |
| michael@0 | 9 | * o Redistributions of source code must retain the above copyright |
| michael@0 | 10 | * notice, this list of conditions and the following disclaimer. |
| michael@0 | 11 | * |
| michael@0 | 12 | * o Redistributions in binary form must reproduce the above copyright |
| michael@0 | 13 | * notice, this list of conditions and the following disclaimer in the |
| michael@0 | 14 | * documentation and/or other materials provided with the distribution. |
| michael@0 | 15 | * |
| michael@0 | 16 | * o Neither the name of Ben Fortuna nor the names of any other contributors |
| michael@0 | 17 | * may be used to endorse or promote products derived from this software |
| michael@0 | 18 | * without specific prior written permission. |
| michael@0 | 19 | * |
| michael@0 | 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| michael@0 | 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| michael@0 | 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| michael@0 | 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
| michael@0 | 24 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| michael@0 | 25 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
| michael@0 | 26 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
| michael@0 | 27 | * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
| michael@0 | 28 | * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
| michael@0 | 29 | * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| michael@0 | 30 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| michael@0 | 31 | */ |
| michael@0 | 32 | package net.fortuna.ical4j.model.property; |
| michael@0 | 33 | |
| michael@0 | 34 | import net.fortuna.ical4j.model.Escapable; |
| michael@0 | 35 | import net.fortuna.ical4j.model.ParameterList; |
| michael@0 | 36 | import net.fortuna.ical4j.model.Property; |
| michael@0 | 37 | import net.fortuna.ical4j.model.PropertyFactoryImpl; |
| michael@0 | 38 | import net.fortuna.ical4j.model.ValidationException; |
| michael@0 | 39 | |
| michael@0 | 40 | /** |
| michael@0 | 41 | * $Id$ |
| michael@0 | 42 | * |
| michael@0 | 43 | * Created: [Apr 6, 2004] |
| michael@0 | 44 | * |
| michael@0 | 45 | * Defines a UID iCalendar component property. |
| michael@0 | 46 | * |
| michael@0 | 47 | * <pre> |
| michael@0 | 48 | * 4.8.4.7 Unique Identifier |
| michael@0 | 49 | * |
| michael@0 | 50 | * Property Name: UID |
| michael@0 | 51 | * |
| michael@0 | 52 | * Purpose: This property defines the persistent, globally unique |
| michael@0 | 53 | * identifier for the calendar component. |
| michael@0 | 54 | * |
| michael@0 | 55 | * Value Type: TEXT |
| michael@0 | 56 | * |
| michael@0 | 57 | * Property Parameters: Non-standard property parameters can be |
| michael@0 | 58 | * specified on this property. |
| michael@0 | 59 | * |
| michael@0 | 60 | * Conformance: The property MUST be specified in the "VEVENT", "VTODO", |
| michael@0 | 61 | * "VJOURNAL" or "VFREEBUSY" calendar components. |
| michael@0 | 62 | * |
| michael@0 | 63 | * Description: The UID itself MUST be a globally unique identifier. The |
| michael@0 | 64 | * generator of the identifier MUST guarantee that the identifier is |
| michael@0 | 65 | * unique. There are several algorithms that can be used to accomplish |
| michael@0 | 66 | * this. The identifier is RECOMMENDED to be the identical syntax to the |
| michael@0 | 67 | * [RFC 822] addr-spec. A good method to assure uniqueness is to put the |
| michael@0 | 68 | * domain name or a domain literal IP address of the host on which the |
| michael@0 | 69 | * identifier was created on the right hand side of the "@", and on the |
| michael@0 | 70 | * left hand side, put a combination of the current calendar date and |
| michael@0 | 71 | * time of day (i.e., formatted in as a DATE-TIME value) along with some |
| michael@0 | 72 | * other currently unique (perhaps sequential) identifier available on |
| michael@0 | 73 | * the system (for example, a process id number). Using a date/time |
| michael@0 | 74 | * value on the left hand side and a domain name or domain literal on |
| michael@0 | 75 | * the right hand side makes it possible to guarantee uniqueness since |
| michael@0 | 76 | * no two hosts should be using the same domain name or IP address at |
| michael@0 | 77 | * the same time. Though other algorithms will work, it is RECOMMENDED |
| michael@0 | 78 | * that the right hand side contain some domain identifier (either of |
| michael@0 | 79 | * the host itself or otherwise) such that the generator of the message |
| michael@0 | 80 | * identifier can guarantee the uniqueness of the left hand side within |
| michael@0 | 81 | * the scope of that domain. |
| michael@0 | 82 | * |
| michael@0 | 83 | * This is the method for correlating scheduling messages with the |
| michael@0 | 84 | * referenced "VEVENT", "VTODO", or "VJOURNAL" calendar component. |
| michael@0 | 85 | * |
| michael@0 | 86 | * The full range of calendar components specified by a recurrence set |
| michael@0 | 87 | * is referenced by referring to just the "UID" property value |
| michael@0 | 88 | * corresponding to the calendar component. The "RECURRENCE-ID" property |
| michael@0 | 89 | * allows the reference to an individual instance within the recurrence |
| michael@0 | 90 | * set. |
| michael@0 | 91 | * |
| michael@0 | 92 | * This property is an important method for group scheduling |
| michael@0 | 93 | * applications to match requests with later replies, modifications or |
| michael@0 | 94 | * deletion requests. Calendaring and scheduling applications MUST |
| michael@0 | 95 | * generate this property in "VEVENT", "VTODO" and "VJOURNAL" calendar |
| michael@0 | 96 | * components to assure interoperability with other group scheduling |
| michael@0 | 97 | * applications. This identifier is created by the calendar system that |
| michael@0 | 98 | * generates an iCalendar object. |
| michael@0 | 99 | * |
| michael@0 | 100 | * Implementations MUST be able to receive and persist values of at |
| michael@0 | 101 | * least 255 characters for this property. |
| michael@0 | 102 | * |
| michael@0 | 103 | * Format Definition: The property is defined by the following notation: |
| michael@0 | 104 | * |
| michael@0 | 105 | * uid = "UID" uidparam ":" text CRLF |
| michael@0 | 106 | * |
| michael@0 | 107 | * uidparam = *(";" xparam) |
| michael@0 | 108 | * |
| michael@0 | 109 | * Example: The following is an example of this property: |
| michael@0 | 110 | * |
| michael@0 | 111 | * UID:19960401T080045Z-4000F192713-0052@host1.com |
| michael@0 | 112 | * </pre> |
| michael@0 | 113 | * |
| michael@0 | 114 | * @author Ben Fortuna |
| michael@0 | 115 | */ |
| michael@0 | 116 | public class Uid extends Property implements Escapable { |
| michael@0 | 117 | |
| michael@0 | 118 | private static final long serialVersionUID = -7139407612536588584L; |
| michael@0 | 119 | |
| michael@0 | 120 | private String value; |
| michael@0 | 121 | |
| michael@0 | 122 | /** |
| michael@0 | 123 | * Default constructor. |
| michael@0 | 124 | */ |
| michael@0 | 125 | public Uid() { |
| michael@0 | 126 | super(UID, PropertyFactoryImpl.getInstance()); |
| michael@0 | 127 | } |
| michael@0 | 128 | |
| michael@0 | 129 | /** |
| michael@0 | 130 | * @param aValue a value string for this component |
| michael@0 | 131 | */ |
| michael@0 | 132 | public Uid(final String aValue) { |
| michael@0 | 133 | super(UID, PropertyFactoryImpl.getInstance()); |
| michael@0 | 134 | setValue(aValue); |
| michael@0 | 135 | } |
| michael@0 | 136 | |
| michael@0 | 137 | /** |
| michael@0 | 138 | * @param aList a list of parameters for this component |
| michael@0 | 139 | * @param aValue a value string for this component |
| michael@0 | 140 | */ |
| michael@0 | 141 | public Uid(final ParameterList aList, final String aValue) { |
| michael@0 | 142 | super(UID, aList, PropertyFactoryImpl.getInstance()); |
| michael@0 | 143 | setValue(aValue); |
| michael@0 | 144 | } |
| michael@0 | 145 | |
| michael@0 | 146 | /** |
| michael@0 | 147 | * {@inheritDoc} |
| michael@0 | 148 | */ |
| michael@0 | 149 | public final void setValue(final String aValue) { |
| michael@0 | 150 | this.value = aValue; |
| michael@0 | 151 | } |
| michael@0 | 152 | |
| michael@0 | 153 | /** |
| michael@0 | 154 | * {@inheritDoc} |
| michael@0 | 155 | */ |
| michael@0 | 156 | public final String getValue() { |
| michael@0 | 157 | return value; |
| michael@0 | 158 | } |
| michael@0 | 159 | |
| michael@0 | 160 | /** |
| michael@0 | 161 | * {@inheritDoc} |
| michael@0 | 162 | */ |
| michael@0 | 163 | public final void validate() throws ValidationException { |
| michael@0 | 164 | // TODO: Auto-generated method stub |
| michael@0 | 165 | } |
| michael@0 | 166 | } |
