biweekly.property

Class RelatedTo

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<String>

biweekly.property.TextProperty

biweekly.property.RelatedTo

public class RelatedTo
extends TextProperty

Defines a relationship between the component that this property belongs to and another component.

Code samples:

 VEvent event = new VEvent();
 
 RelatedTo relatedTo = new RelatedTo("uid-value");
 event.addRelatedTo(relatedTo);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.115-6, RFC 2445 p.109-10, vCal 1.0 p.33-4

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
RelatedTo(RelatedTo original) Copy constructor.
RelatedTo(String uid) Creates a related-to property.

Method Summary

Methods

Modifier and Type	Method and Description
RelatedTo	copy() Creates a copy of this property object.
RelationshipType	getRelationshipType() Gets the relationship type.
void	setRelationshipType(RelationshipType relationshipType) Sets the relationship type.

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

RelatedTo

public RelatedTo(String uid)

Creates a related-to property.

Parameters:

uid - the value of the Uid property of the component that this property is referencing

RelatedTo

public RelatedTo(RelatedTo original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getRelationshipType

public RelationshipType getRelationshipType()

Gets the relationship type.

Returns:

the relationship type (e.g. "child") or null if not set

See Also:

RFC 5545 p.25

setRelationshipType

public void setRelationshipType(RelationshipType relationshipType)

Sets the relationship type.

Parameters:

relationshipType - the relationship type (e.g. "child") or null to remove

See Also:

RFC 5545 p.25

copy

public RelatedTo 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