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

public Class Attendee

extends Property
Class Inheritance
Imports
net.fortuna.ical4j.model.Content, .ParameterList, .Property, .PropertyFactory, net.fortuna.ical4j.model.component.Participant, net.fortuna.ical4j.util.Strings, .Uris, net.fortuna.ical4j.validate.ValidationException, .ValidationResult, net.fortuna.ical4j.validate.property.RelationshipPropertyValidators, java.net.URI, .URISyntaxException
$Id$

Created: [Apr 6, 2004]

Defines an ATTENDEE iCalendar component property.

Author
benf

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Attendee.Factory

Field Summary

Modifier and TypeField and Description
private URI
calAddress

private static final long
serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

Inherited from net.fortuna.ical4j.model.Property:
ACKNOWLEDGEDACTIONATTACHATTENDEEBUSYTYPECALENDAR_ADDRESSCALSCALECATEGORIESCLASSCOMMENTCOMPLETEDCONTACTCOUNTRYCREATEDDESCRIPTIONDTENDDTSTAMPDTSTARTDUEDURATIONEXDATEEXPERIMENTAL_PREFIXEXRULEEXTENDED_ADDRESSFREEBUSYGEOLAST_MODIFIEDLOCALITYLOCATIONLOCATION_TYPEMETHODNAMEORGANIZERPARTICIPANT_TYPEPERCENT_COMPLETEPOSTALCODEPRIORITYPRODIDPROXIMITYRDATERECURRENCE_IDREGIONRELATED_TOREPEATREQUEST_STATUSRESOURCE_TYPERESOURCESRRULESEQUENCESTATUSSTREET_ADDRESSSTRUCTURED_DATASTYLED_DESCRIPTIONSUMMARYTELTRANSPTRIGGERTZIDTZID_ALIAS_OFTZNAMETZOFFSETFROMTZOFFSETTOTZUNTILTZURLUIDURLVERSIONXML

Constructor Summary

AccessConstructor and Description
public
Attendee()

Default constructor.

public
Attendee(final String
a value string for this component
aValue)

public
Attendee(final ParameterList
a list of parameters for this component
aList, final String
a value string for this component
aValue)

public
Attendee(final URI
a URI
aUri)

public
Attendee(final ParameterList
a list of parameters for this component
aList, final URI
a URI
aUri)

public
Attendee(Participant
a schedulable participant
participant)

Construct an attendee from a participant.

public
Attendee(ParameterList parameters, Participant
a schedulable participant
participant)

Construct an attendee from a participant.

Method Summary

Modifier and TypeMethod and Description
public final URI

Returns:

Returns the calAddress.
getCalAddress()

public final String
getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

protected PropertyFactory<Attendee>
newFactory()

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

Returns a new property factory used to create deep copies.

public final void
setCalAddress(final URI
The calAddress to set.
calAddress)

public final void
setValue(final String
a string representation of the property value
aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

public ValidationResult
validate()

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

Perform validation on a property.

Inherited from net.fortuna.ical4j.model.Property:
addcompareTocopyequalsgetFluentTargetgetNamegetParametergetParametergetParameterListgetParametersgetPrefixgetRequiredParametergetRequiredParameterhashCoderemoveremoveAllreplacesetParameterssetPrefixtoString

Field Detail

calAddressback to summary
private URI calAddress
serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

Constructor Detail

Attendeeback to summary
public Attendee()

Default constructor.

Attendeeback to summary
public Attendee(final String aValue)
Parameters
aValue:String

a value string for this component

Exceptions
IllegalArgumentException:
where the specified value string is not a valid uri
Attendeeback to summary
public Attendee(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

Attendeeback to summary
public Attendee(final URI aUri)
Parameters
aUri:URI

a URI

Attendeeback to summary
public Attendee(final ParameterList aList, final URI aUri)
Parameters
aList:ParameterList

a list of parameters for this component

aUri:URI

a URI

Attendeeback to summary
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:Participant

a schedulable participant

Attendeeback to summary
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:Participant

a schedulable participant

Method Detail

getCalAddressback to summary
public final URI getCalAddress()
Returns:URI

Returns the calAddress.

getValueback to summary
public final String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
newFactoryback to summary
protected PropertyFactory<Attendee> newFactory()

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

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

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<Attendee>

a property factory instance

Annotations
@Override
setCalAddressback to summary
public final void setCalAddress(final URI calAddress)
Parameters
calAddress:URI

The calAddress to set.

setValueback to summary
public final void setValue(final String aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Doc from net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

Parameters
aValue:String

a string representation of the property value

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

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

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

Perform validation on a property.

Annotations
@Override
Exceptions
ValidationException:
where the property is not in a valid state
net.fortuna.ical4j.model.property back to summary

public Class Attendee.Factory

extends Factory
implements PropertyFactory<Attendee>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
public
Factory()

Method Summary

Modifier and TypeMethod and Description
public Attendee
createProperty(final ParameterList
a list of property parameters
parameters, final String
a property value
value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public Attendee
createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public Attendee createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:Attendee

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public Attendee createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:Attendee

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override