java.lang.Object
net.fortuna.ical4j.model.Content
net.fortuna.ical4j.model.Component
net.fortuna.ical4j.model.component.Participant
- All Implemented Interfaces:
Serializable,Comparable<Component>,ChangeManagementPropertyAccessor,ComponentContainer<Component>,ComponentListAccessor<Component>,FluentComponent,LocationsAccessor,PropertyContainer,PropertyListAccessor,Prototype<Component>,ResourcesAccessor
public class Participant
extends Component
implements ComponentContainer<Component>, ChangeManagementPropertyAccessor, LocationsAccessor, ResourcesAccessor
$Id$ [May 1 2017]
Defines an iCalendar PARTICIPANT component.
Component name: PARTICIPANT
Purpose: This component provides information about a participant in
an event or task.
Conformance: This component can be specified multiple times in a
"VEVENT", "VTODO", "VJOURNAL" or "VFREEBUSY" calendar component.
Description: This component provides information about a participant
in a calendar component. A participant may be an attendee in a
scheduling sense and the ATTENDEE property may be specified in
addition. Participants can be individuals or organizations, for
example a soccer team, the spectators or the musicians.
STRUCTURED-DATA properties if present may refer to definitions of
the participant - such as a vCard.
The CALENDAR-ADDRESS property if present will provide a cal-
address. If an ATTENDEE property has the same value the
participant is considered schedulable. The PARTICIPANT component
can be used to contain additional meta-data related to the
attendee.
Format Definition:
This property is defined by the following notation:
participantc = "BEGIN" ":" "PARTICIPANT" CRLF
( partprop / locationc / resourcec )
"END" ":" "PARTICIPANT" CRLF
partprop = ; the elements herein may appear in any order,
; and the order is not significant.
uid
participanttype
(calendaraddress)
(created)
(description)
(dtstamp)
(geo)
(last-mod)
(priority)
(seq)
(status)
(summary)
(url)
attach
categories
comment
contact
location
rstatus
related
resources
strucloc
strucres
styleddescription
sdataprop
iana-prop
Note: When the PRIORITY is supplied it defines the ordering of
PARTICIPANT components with the same value for the TYPE parameter.
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from class net.fortuna.ical4j.model.Component
AVAILABLE, BEGIN, components, END, EXPERIMENTAL_PREFIX, PARTICIPANT, properties, VALARM, VAVAILABILITY, VEVENT, VFREEBUSY, VJOURNAL, VLOCATION, VRESOURCE, VTIMEZONE, VTODO, VVENUEFields inherited from interface net.fortuna.ical4j.model.PropertyContainer
ADD_IF_NOT_PRESENT -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Participant(PropertyList properties) Constructor.Participant(PropertyList properties, ComponentList<? extends Component> components) Constructor. -
Method Summary
Modifier and TypeMethodDescriptioncopy()Create a (deep) copy of this component.final Optional<CalendarAddress>Returns the optional calendar address property.Deprecated.final Optional<Description>Returns the optional description property.Returns the mandatory PARTICIPANT-TYPE property.Returns the optional summary property.getUrl()protected ComponentFactory<Participant>Returns a new component factory used to create deep copies.voidsetComponentList(ComponentList<Component> components) validate(boolean recurse) Perform validation on a component.Methods inherited from class net.fortuna.ical4j.model.Component
calculateRecurrenceSet, compareTo, equals, getFluentTarget, getName, getProperties, getPropertyList, getUid, getValue, hashCode, setPropertyList, toString, validate, validatePropertiesMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface net.fortuna.ical4j.model.ChangeManagementPropertyAccessor
getCreated, getDateTimeStamp, getLastModified, getSequenceMethods inherited from interface net.fortuna.ical4j.model.ComponentContainer
add, remove, replace, withMethods inherited from interface net.fortuna.ical4j.model.ComponentListAccessor
getComponent, getComponentsMethods inherited from interface net.fortuna.ical4j.model.FluentComponent
withPropertyMethods inherited from interface net.fortuna.ical4j.model.LocationsAccessor
getLocationsMethods inherited from interface net.fortuna.ical4j.model.PropertyContainer
add, addAll, remove, removeAll, removeIf, replace, setPropertyList, withMethods inherited from interface net.fortuna.ical4j.model.PropertyListAccessor
getProperties, getProperty, getProperty, getPropertyList, getRequiredProperty, getRequiredPropertyMethods inherited from interface net.fortuna.ical4j.model.ResourcesAccessor
getResources
-
Constructor Details
-
Participant
public Participant()Default constructor. -
Participant
Constructor.- Parameters:
properties- a list of properties
-
Participant
Constructor.- Parameters:
properties- a list of properties
-
-
Method Details
-
validate
Perform validation on a component.- Specified by:
validatein classComponent- Parameters:
recurse- indicates whether to validate the component's properties- Throws:
ValidationException- where the component is not in a valid state
-
getComponentList
- Specified by:
getComponentListin interfaceComponentListAccessor<Component>- Returns:
- Returns the underlying component list.
-
setComponentList
- Specified by:
setComponentListin interfaceComponentContainer<Component>
-
getCalendarAddress
Returns the optional calendar address property.- Returns:
- the CALENDAR_ADDRESS property or null if not specified
-
getDateStamp
Deprecated.- Returns:
- the optional date-stamp property
-
getDescription
Returns the optional description property.- Returns:
- the DESCRIPTION property or null if not specified
-
getParticipantType
Returns the mandatory PARTICIPANT-TYPE property.- Returns:
- the PARTICIPANT-TYPE property or null if not specified
-
getPriority
- Returns:
- the optional priority property for an event
-
getStatus
- Returns:
- the optional status property for an event
-
getSummary
Returns the optional summary property.- Returns:
- the SUMMARY property or null if not specified
-
getUrl
- Returns:
- the optional URL property for an event
-
copy
Description copied from class:ComponentCreate a (deep) copy of this component. -
newFactory
Description copied from class:ComponentReturns a new component factory used to create deep copies.- Specified by:
newFactoryin classComponent- Returns:
- a component factory instance
-
ChangeManagementPropertyAccessor.getDateTimeStamp()