biweekly.property

Class Uid

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<String>

biweekly.property.TextProperty

biweekly.property.Uid

public class Uid
extends TextProperty

Defines a unique identifier for a component. Note that all components that require UID properties are automatically given a random one on creation.

Code sample:

 VEvent event = new VEvent();
 
 Uid uid = new Uid("19970610T172345Z-AF23B2@example.com");
 event.setUid(uid);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.117-8, RFC 2445 p.111-2, vCal 1.0 p.37, draft-ietf-calext-extensions-01 p.6

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

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 universally unique identifier.

Methods inherited from class biweekly.property.ValuedProperty

equals, getValue, getValue, hashCode, setValue, toStringValues, validate, valueEquals, valueHashCode

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, 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 (can be anything)

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 universally unique identifier.

Returns:

the property

copy

public Uid copy()

Description copied from class: ICalProperty

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 ICalProperty.ICalProperty(ICalProperty) super constructor to ensure that the 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 ICalendar class's copy constructor ).

Overrides:

copy in class ICalProperty

Returns:

the copy