001 package ezvcard.property;
002
003 import java.util.UUID;
004
005 /*
006 Copyright (c) 2013, Michael Angstadt
007 All rights reserved.
008
009 Redistribution and use in source and binary forms, with or without
010 modification, are permitted provided that the following conditions are met:
011
012 1. Redistributions of source code must retain the above copyright notice, this
013 list of conditions and the following disclaimer.
014 2. Redistributions in binary form must reproduce the above copyright notice,
015 this list of conditions and the following disclaimer in the documentation
016 and/or other materials provided with the distribution.
017
018 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
019 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
020 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
021 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
022 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
023 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
024 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
025 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
026 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028
029 The views and conclusions contained in the software and documentation are those
030 of the authors and should not be interpreted as representing official policies,
031 either expressed or implied, of the FreeBSD Project.
032 */
033
034 /**
035 * A globally unique identifier of the person.
036 *
037 * <p>
038 * <b>Code sample</b>
039 * </p>
040 *
041 * <pre class="brush:java">
042 * VCard vcard = new VCard();
043 *
044 * Uid uid = new Uid("urn:uuid:b8767877-b4a1-4c70-9acc-505d3819e519");
045 * vcard.setUid(uid);
046 *
047 * //generate a random UID
048 * uid = Uid.random();
049 * vcard.setUid(uid);
050 * </pre>
051 *
052 * <p>
053 * <b>Property name:</b> {@code UID}
054 * </p>
055 * <p>
056 * <b>Supported versions:</b> {@code 2.1, 3.0, 4.0}
057 * </p>
058 * @author Michael Angstadt
059 */
060 public class Uid extends UriProperty {
061 /**
062 * Creates a UID property.
063 * @param uid the UID
064 */
065 public Uid(String uid) {
066 super(uid);
067 }
068
069 /**
070 * Generates a UID property that contains a random UID URI.
071 * @return a UID property with a random UID URI
072 */
073 public static Uid random() {
074 String uuid = UUID.randomUUID().toString();
075 return new Uid("urn:uuid:" + uuid);
076 }
077 }