Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.component

public Class Participant

extends Component
implements Prototype<Participant>, ComponentContainer<Component>, ChangeManagementPropertyAccessor, LocationsAccessor, ResourcesAccessor
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.ResourcesAccessor, net.fortuna.ical4j.model.ComponentContainer, net.fortuna.ical4j.model.ComponentListAccessor, net.fortuna.ical4j.model.LocationsAccessor, net.fortuna.ical4j.model.ChangeManagementPropertyAccessor, net.fortuna.ical4j.model.PropertyContainer, net.fortuna.ical4j.model.PropertyListAccessor, net.fortuna.ical4j.model.Prototype
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.model.property.*, net.fortuna.ical4j.validate.*, java.util.Optional, java.util.stream.Collectors

$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.
 
Author
Mike Douglass

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private static final long
private final Validator<Participant>
Inherited from net.fortuna.ical4j.model.Component:
AVAILABLEBEGINcomponentsENDEXPERIMENTAL_PREFIXPARTICIPANTpropertiesVALARMVAVAILABILITYVEVENTVFREEBUSYVJOURNALVLOCATIONVRESOURCEVTIMEZONEVTODOVVENUE

Constructor Summary

AccessConstructor and Description
public
Participant()

Default constructor.

public
Participant(final PropertyList
a list of properties
properties
)

Constructor.

public
Participant(final PropertyList
a list of properties
properties
,
final ComponentList<? extends Component> components)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public Participant
copy()

Overrides net.fortuna.ical4j.model.Component.copy.

Implements net.fortuna.ical4j.model.Prototype.copy.

Create a (deep) copy of this component.

public final Optional<CalendarAddress>

Returns:

the CALENDAR_ADDRESS property or null if not specified
getCalendarAddress
()

Returns the optional calendar address property.

public ComponentList<Component>

Returns:

Returns the underlying component list.
getComponentList
()

Implements net.fortuna.ical4j.model.ComponentListAccessor.getComponentList.

public final Optional<DtStamp>

Returns:

the optional date-stamp property
getDateStamp
()

public final Optional<Description>

Returns:

the DESCRIPTION property or null if not specified
getDescription
()

Returns the optional description property.

public Optional<ParticipantType>

Returns:

the PARTICIPANT-TYPE property or null if not specified
getParticipantType
()

Returns the mandatory PARTICIPANT-TYPE property.

public final Optional<Priority>

Returns:

the optional priority property for an event
getPriority
()

public final Optional<Status>

Returns:

the optional status property for an event
getStatus
()

public final Optional<Summary>

Returns:

the SUMMARY property or null if not specified
getSummary
()

Returns the optional summary property.

public final Optional<Url>

Returns:

the optional URL property for an event
getUrl
()

protected ComponentFactory<Participant>
newFactory()

Implements abstract net.fortuna.ical4j.model.Component.newFactory.

Returns a new component factory used to create deep copies.

public void
public ValidationResult
validate(final boolean
indicates whether to validate the component's properties
recurse
)

Implements abstract net.fortuna.ical4j.model.Component.validate.

Perform validation on a component.

Inherited from net.fortuna.ical4j.model.Component:
calculateRecurrenceSetcompareToequalsgetFluentTargetgetNamegetPropertiesgetPropertyListgetUidgetValuehashCodesetPropertyListtoStringvalidatevalidateProperties

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Component.serialVersionUID.

validatorback to summary
private final Validator<Participant> validator

Constructor Detail

Participantback to summary
public Participant()

Default constructor.

Participantback to summary
public Participant(final PropertyList properties)

Constructor.

Parameters
properties:PropertyList

a list of properties

Participantback to summary
public Participant(final PropertyList properties, final ComponentList<? extends Component> components)

Constructor.

Parameters
properties:PropertyList

a list of properties

Method Detail

copyback to summary
public Participant copy()

Overrides net.fortuna.ical4j.model.Component.copy.

Implements net.fortuna.ical4j.model.Prototype.copy.

Doc from net.fortuna.ical4j.model.Component.copy.

Create a (deep) copy of this component.

Returns:Participant

the component copy

Annotations
@Override
getCalendarAddressback to summary
public final Optional<CalendarAddress> getCalendarAddress()

Returns the optional calendar address property.

Returns:Optional<CalendarAddress>

the CALENDAR_ADDRESS property or null if not specified

getComponentListback to summary
public ComponentList<Component> getComponentList()

Implements net.fortuna.ical4j.model.ComponentListAccessor.getComponentList.

Returns:ComponentList<Component>

Returns the underlying component list.

Annotations
@Override
getDateStampback to summary
public final Optional<DtStamp> getDateStamp()
Returns:Optional<DtStamp>

the optional date-stamp property

Annotations
@Deprecated
getDescriptionback to summary
public final Optional<Description> getDescription()

Returns the optional description property.

Returns:Optional<Description>

the DESCRIPTION property or null if not specified

getParticipantTypeback to summary
public Optional<ParticipantType> getParticipantType()

Returns the mandatory PARTICIPANT-TYPE property.

Returns:Optional<ParticipantType>

the PARTICIPANT-TYPE property or null if not specified

getPriorityback to summary
public final Optional<Priority> getPriority()
Returns:Optional<Priority>

the optional priority property for an event

getStatusback to summary
public final Optional<Status> getStatus()
Returns:Optional<Status>

the optional status property for an event

getSummaryback to summary
public final Optional<Summary> getSummary()

Returns the optional summary property.

Returns:Optional<Summary>

the SUMMARY property or null if not specified

getUrlback to summary
public final Optional<Url> getUrl()
Returns:Optional<Url>

the optional URL property for an event

newFactoryback to summary
protected ComponentFactory<Participant> newFactory()

Implements abstract net.fortuna.ical4j.model.Component.newFactory.

Doc from net.fortuna.ical4j.model.Component.newFactory.

Returns a new component factory used to create deep copies.

Returns:ComponentFactory<Participant>

a component factory instance

Annotations
@Override
setComponentListback to summary
public void setComponentList(ComponentList<Component> components)

Implements net.fortuna.ical4j.model.ComponentContainer.setComponentList.

Annotations
@Override
validateback to summary
public ValidationResult validate(final boolean recurse) throws ValidationException

Implements abstract net.fortuna.ical4j.model.Component.validate.

Doc from net.fortuna.ical4j.model.Component.validate.

Perform validation on a component.

Parameters
recurse:boolean

indicates whether to validate the component's properties

Exceptions
ValidationException:
where the component is not in a valid state
net.fortuna.ical4j.model.component back to summary

public Class Participant.Factory

extends Factory
implements ComponentFactory<Participant>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.ComponentFactory

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Participant
public Participant
public Participant
Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createComponentback to summary
public Participant createComponent()

Implements net.fortuna.ical4j.model.ComponentFactory.createComponent.

Annotations
@Override
createComponentback to summary
public Participant createComponent(PropertyList properties)

Implements net.fortuna.ical4j.model.ComponentFactory.createComponent.

Annotations
@Override
createComponentback to summary
public Participant createComponent(final PropertyList properties, final ComponentList<?> subComponents)

Overrides default net.fortuna.ical4j.model.ComponentFactory.createComponent.

Annotations
@Override