ezvcard.property

Class Uid

java.lang.Object

ezvcard.property.VCardProperty

ezvcard.property.SimpleProperty<String>

ezvcard.property.TextProperty

ezvcard.property.UriProperty

ezvcard.property.Uid

All Implemented Interfaces:

Comparable<VCardProperty>

public class Uid
extends UriProperty

Defines a globally unique identifier for this vCard.

Code sample

 VCard vcard = new VCard();
 
 Uid uid = new Uid("urn:uuid:b8767877-b4a1-4c70-9acc-505d3819e519");
 vcard.setUid(uid);
 
 //or, generate a random UID
 uid = Uid.random();
 vcard.setUid(uid);
 

Property name: UID

Supported versions: 2.1, 3.0, 4.0

Author:

Michael Angstadt

See Also:

RFC 6350 p.46, RFC 2426 p.24, vCard 2.1 p.21

Field Summary

Fields inherited from class ezvcard.property.SimpleProperty

value

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
Uid(String uid) Creates a UID property.
Uid(Uid original) Copy constructor.

Method Summary

Modifier and Type	Method and Description
Uid	copy() Creates a copy of this property object.
static Uid	random() Creates a UID property that contains a random UUID URI.

Methods inherited from class ezvcard.property.SimpleProperty

_validate, equals, getValue, hashCode, setValue, toStringValues

Methods inherited from class ezvcard.property.VCardProperty

addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, isSupportedBy, removeParameter, setGroup, setParameter, setParameters, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Uid

public Uid(String uid)

Creates a UID property.

Parameters:

uid - the UID

Uid

public Uid(Uid original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

random

public static Uid random()

Creates a UID property that contains a random UUID URI.

Returns:

the property

copy

public Uid copy()

Description copied from class: VCardProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the VCardProperty.VCardProperty(VCardProperty) super constructor to ensure that the group name and parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the VCard class's copy constructor).

Overrides:

copy in class VCardProperty

Returns:

the copy