biweekly.property.RelatedTo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of biweekly Show documentation
An iCalendar parser/writer library written in Java.
The newest version!
package biweekly.property;

import biweekly.parameter.RelationshipType;

/*
 Copyright (c) 2013-2024, Michael Angstadt
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met: 

 1. Redistributions of source code must retain the above copyright notice, this
 list of conditions and the following disclaimer. 
 2. Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution. 

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * 
 * 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 RFC 5545
 * p.115-6
 * @see RFC 2445
 * p.109-10
 * @see vCal 1.0 p.33-4
 */
public class RelatedTo extends TextProperty {
	/**
	 * Creates a related-to property.
	 * @param uid the value of the {@link Uid} property of the component that
	 * this property is referencing
	 */
	public RelatedTo(String uid) {
		super(uid);
	}

	/**
	 * Copy constructor.
	 * @param original the property to make a copy of
	 */
	public RelatedTo(RelatedTo original) {
		super(original);
	}

	/**
	 * Gets the relationship type.
	 * @return the relationship type (e.g. "child") or null if not set
	 * @see RFC 5545
	 * p.25
	 */
	public RelationshipType getRelationshipType() {
		return parameters.getRelationshipType();
	}

	/**
	 * Sets the relationship type.
	 * @param relationshipType the relationship type (e.g. "child") or null to
	 * remove
	 * @see RFC 5545
	 * p.25
	 */
	public void setRelationshipType(RelationshipType relationshipType) {
		parameters.setRelationshipType(relationshipType);
	}

	@Override
	public RelatedTo copy() {
		return new RelatedTo(this);
	}
}