001    package ezvcard.types;
002    
003    import java.util.UUID;
004    
005    /*
006     Copyright (c) 2012, 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     * <pre>
038     * VCard vcard = new VCard();
039     * 
040     * UidType uid = new UidType(&quot;urn:uuid:b8767877-b4a1-4c70-9acc-505d3819e519&quot;);
041     * vcard.setUid(uid);
042     * 
043     * //generate a random UID
044     * uid = UidType.random();
045     * vcard.setUid(uid);
046     * </pre>
047     * 
048     * <p>
049     * vCard property name: UID
050     * </p>
051     * <p>
052     * vCard versions: 2.1, 3.0, 4.0
053     * </p>
054     * @author Michael Angstadt
055     */
056    public class UidType extends UriType {
057            public static final String NAME = "UID";
058    
059            public UidType() {
060                    this(null);
061            }
062    
063            /**
064             * @param uid the UID
065             */
066            public UidType(String uid) {
067                    super(NAME, uid);
068            }
069    
070            /**
071             * Generates a UID type that contains a random UID URI.
072             * @return a UID type with a random UID URI
073             */
074            public static UidType random() {
075                    String uuid = UUID.randomUUID().toString();
076                    return new UidType("urn:uuid:" + uuid);
077            }
078    }