Class Participant
- java.lang.Object
-
- net.fortuna.ical4j.model.Content
-
- net.fortuna.ical4j.model.Component
-
- net.fortuna.ical4j.model.component.Participant
-
- All Implemented Interfaces:
Serializable
,ComponentContainer<Component>
,FluentComponent
,PropertyContainer
public class Participant extends Component implements ComponentContainer<Component>
$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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Participant.Factory
-
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, VVENUE
-
-
Constructor Summary
Constructors Constructor Description Participant()
Default constructor.Participant(PropertyList properties)
Constructor.Participant(PropertyList properties, ComponentList<? extends Component> components)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Optional<CalendarAddress>
getCalendarAddress()
Returns the optional calendar address property.ComponentList<Component>
getComponentList()
<C extends Component>
List<C>getComponents()
Optional<Created>
getCreated()
Optional<DtStamp>
getDateStamp()
Optional<Description>
getDescription()
Returns the optional description property.Optional<LastModified>
getLastModified()
Optional<ParticipantType>
getParticipantType()
Returns the mandatory PARTICIPANT-TYPE property.Optional<Priority>
getPriority()
Optional<Sequence>
getSequence()
Optional<Status>
getStatus()
Optional<Summary>
getSummary()
Returns the optional summary property.Optional<Uid>
getUid()
Returns the UID property of this component if available.Optional<Url>
getUrl()
protected ComponentFactory<Participant>
newFactory()
Returns a new component factory used to create deep copies.void
setComponentList(ComponentList<Component> components)
ValidationResult
validate(boolean recurse)
Perform validation on a component.-
Methods inherited from class net.fortuna.ical4j.model.Component
calculateRecurrenceSet, copy, equals, getFluentTarget, getName, getProperties, getPropertyList, getValue, hashCode, setPropertyList, toString, validate, validateProperties
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.fortuna.ical4j.model.ComponentContainer
add, getComponent, getComponents, remove, replace
-
Methods inherited from interface net.fortuna.ical4j.model.FluentComponent
withProperty
-
Methods inherited from interface net.fortuna.ical4j.model.PropertyContainer
add, addAll, getProperties, getProperty, getRequiredProperty, remove, removeAll, replace
-
-
-
-
Constructor Detail
-
Participant
public Participant()
Default constructor.
-
Participant
public Participant(PropertyList properties)
Constructor.- Parameters:
properties
- a list of properties
-
Participant
public Participant(PropertyList properties, ComponentList<? extends Component> components)
Constructor.- Parameters:
properties
- a list of properties
-
-
Method Detail
-
validate
public ValidationResult validate(boolean recurse) throws ValidationException
Perform validation on a component.- Specified by:
validate
in classComponent
- Parameters:
recurse
- indicates whether to validate the component's properties- Throws:
ValidationException
- where the component is not in a valid state
-
getComponentList
public ComponentList<Component> getComponentList()
- Specified by:
getComponentList
in interfaceComponentContainer<Component>
- Returns:
- Returns the underlying component list.
-
setComponentList
public void setComponentList(ComponentList<Component> components)
- Specified by:
setComponentList
in interfaceComponentContainer<Component>
-
getCalendarAddress
public final Optional<CalendarAddress> getCalendarAddress()
Returns the optional calendar address property.- Returns:
- the CALENDAR_ADDRESS property or null if not specified
-
getCreated
public final Optional<Created> getCreated()
- Returns:
- the optional creation-time property for an event
-
getDateStamp
public final Optional<DtStamp> getDateStamp()
- Returns:
- the optional date-stamp property
-
getDescription
public final Optional<Description> getDescription()
Returns the optional description property.- Returns:
- the DESCRIPTION property or null if not specified
-
getLastModified
public final Optional<LastModified> getLastModified()
- Returns:
- the optional last-modified property for an event
-
getParticipantType
public Optional<ParticipantType> getParticipantType()
Returns the mandatory PARTICIPANT-TYPE property.- Returns:
- the PARTICIPANT-TYPE property or null if not specified
-
getPriority
public final Optional<Priority> getPriority()
- Returns:
- the optional priority property for an event
-
getSequence
public final Optional<Sequence> getSequence()
- Returns:
- the optional sequence number property for an event
-
getStatus
public final Optional<Status> getStatus()
- Returns:
- the optional status property for an event
-
getSummary
public final Optional<Summary> getSummary()
Returns the optional summary property.- Returns:
- the SUMMARY property or null if not specified
-
getUid
public final Optional<Uid> getUid()
Returns the UID property of this component if available.- Returns:
- a Uid instance, or null if no UID property exists
-
newFactory
protected ComponentFactory<Participant> newFactory()
Description copied from class:Component
Returns a new component factory used to create deep copies.- Specified by:
newFactory
in classComponent
- Returns:
- a component factory instance
-
-