Module ical4j.core

Package net.fortuna.ical4j.model.property

Class Attendee

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.Attendee

All Implemented Interfaces:

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

public class Attendee
extends Property

$Id$

Created: [Apr 6, 2004]

Defines an ATTENDEE iCalendar component property.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Attendee.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
Attendee()	Default constructor.
Attendee(String aValue)
Attendee(URI aUri)
Attendee(Participant participant)	Construct an attendee from a participant.
Attendee(ParameterList aList, String aValue)
Attendee(ParameterList aList, URI aUri)
Attendee(ParameterList parameters, Participant participant)	Construct an attendee from a participant.

Method Summary

Modifier and Type	Method	Description
final URI	getCalAddress()
final String	getValue()
protected PropertyFactory<Attendee>	newFactory()	Returns a new property factory used to create deep copies.
final void	setCalAddress(URI calAddress)
final 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

Attendee

public Attendee()

Default constructor.

Attendee

public Attendee(String aValue)

Parameters:

aValue - a value string for this component

Throws:

IllegalArgumentException - where the specified value string is not a valid uri

Attendee

public Attendee(ParameterList aList,
 String aValue)

Parameters:

aList - a list of parameters for this component

aValue - a value string for this component

Attendee

public Attendee(URI aUri)

Parameters:

aUri - a URI

Attendee

public Attendee(ParameterList aList,
 URI aUri)

Parameters:

aList - a list of parameters for this component

aUri - a URI

Attendee

public Attendee(Participant participant)

Construct an attendee from a participant. The expectation is that the participant is schedulable (i.e. has a calendar address) and an exception will be thrown where this is not the case.

Parameters:

participant - a schedulable participant

Attendee

public Attendee(ParameterList parameters,
 Participant participant)

Construct an attendee from a participant. The expectation is that the participant is schedulable (i.e. has a calendar address) and an exception will be thrown where this is not the case.

Parameters:

participant - a schedulable participant

Method Details

setValue

public final void setValue(String aValue)

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

Perform validation on a property.

Specified by:

validate in class Property

Throws:

ValidationException - where the property is not in a valid state

getCalAddress

public final URI getCalAddress()

Returns:

Returns the calAddress.

getValue

public final String getValue()

Specified by:

getValue in class Content

Returns:

the content value

setCalAddress

public final void setCalAddress(URI calAddress)

Parameters:

calAddress - The calAddress to set.

newFactory

protected PropertyFactory<Attendee> 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