Module ical4j.core

Package net.fortuna.ical4j.model.property

Class RefId

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.RefId

All Implemented Interfaces:

Serializable, Comparable<Property>, FluentProperty, Prototype<Property>

public class RefId
extends Property

     Purpose:
     This property value acts as a key for associated iCalendar entities.
 Value type:
     TEXT
 Property Parameters:
     Non-standard parameters can be specified on this property.
 Conformance:
     This property can be specified zero or more times in any iCalendar component.
 Description:
     The value of this property is free-form text that creates an identifier for associated components. All components that use the same REFID value are associated through that value and can be located or retrieved as a group. For example, all of the events in a travel itinerary would have the same REFID value, so as to be grouped together.
 Format Definition:

     This property is defined by the following notation:

   refid      = "REFID" refidparam ":" text CRLF


   refidparam      = *(";" other-param)
 

See Also:

• rfc9253
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RefId.Factory

Field Summary

Fields inherited from class net.fortuna.ical4j.model.Property

ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION, XML

Constructor Summary

Constructors

Constructor	Description
RefId()
RefId(String value)
RefId(ParameterList aList, String value)

Method Summary

Modifier and Type	Method	Description
String	getValue()
protected PropertyFactory<?>	newFactory()	Returns a new property factory used to create deep copies.
void	setValue(String aValue)	Sets the current value of the property.
ValidationResult	validate()	Perform validation on a property.

Methods inherited from class net.fortuna.ical4j.model.Property

add, compareTo, copy, equals, getFluentTarget, getName, getParameter, getParameter, getParameterList, getParameters, getPrefix, getRequiredParameter, getRequiredParameter, hashCode, remove, removeAll, replace, setParameters, setPrefix, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fortuna.ical4j.model.FluentProperty

withParameter

Constructor Details

RefId

public RefId()

RefId

public RefId(String value)

RefId

public RefId(ParameterList aList,
 String value)

Method Details

getValue

public String getValue()

Specified by:

getValue in class Content

Returns:

the content value

setValue

public void setValue(String aValue)

Description copied from class: Property

Sets the current value of the property.

Specified by:

setValue in class Property

Parameters:

aValue - a string representation of the property value

validate

public ValidationResult validate()
                          throws ValidationException

Description copied from class: Property

Perform validation on a property.

Specified by:

validate in class Property

Throws:

ValidationException - where the property is not in a valid state

newFactory

protected PropertyFactory<?> newFactory()

Description copied from class: Property

Returns a new property factory used to create deep copies.

Specified by:

newFactory in class Property

Returns:

a property factory instance