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

public Class Email

extends Parameter
implements Encodable
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.Encodable
Imports
net.fortuna.ical4j.model.Content, .Encodable, .Parameter, .ParameterFactory, net.fortuna.ical4j.util.CompatibilityHints

From specification:
 Parameter Name:  EMAIL

 Purpose:  To specify an email address that is used to identify or
 contact an organizer or attendee.

 Format Definition:  This property parameter is defined by the
 following notation:

 emailparam = "EMAIL" "=" param-value

 Description:  This property parameter MAY be specified on "ORGANIZER"
 or "ATTENDEE" properties.  This property can be used in situations
 where the calendar user address value of "ORGANIZER" and
 "ATTENDEE" properties is not likely to be an identifier that
 recipients of scheduling messages could use to match the calendar
 user with, for example, an address book entry.  The value of this
 property is an email address that can easily be matched by
 recipients.  Recipients can also use this value as an alternative
 means of contacting the calendar user via email.  If a recipient's
 calendar user agent allows the recipient to save contact
 information based on the "ORGANIZER" or "ATTENDEE" properties,
 those calendar user agents SHOULD use any "EMAIL" property
 parameter value for the email address of the contact over any
 mailto: calendar user address specified as the value of the
 property.  Calendar user agents SHOULD NOT include an "EMAIL"
 property parameter when its value matches the calendar user
 address specified as the value of the property.

 Example:

 ATTENDEE;CN=Cyrus Daboo;[email protected]:mailto:opaque-toke
 [email protected]

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private final String
private static final String
private static final long
Inherited from net.fortuna.ical4j.model.Parameter:
ABBREVALTREPCNCUTYPEDELEGATED_FROMDELEGATED_TODERIVEDDIRDISPLAYEMAILENCODINGEXPERIMENTAL_PREFIXFBTYPEFEATUREFMTTYPELABELLANGUAGEMEMBERORDERPARTSTATRANGERELATEDRELTYPEROLERSVPSCHEDULE_AGENTSCHEDULE_STATUSSCHEMASENT_BYTYPETZIDVALUEVVENUE

Constructor Summary

AccessConstructor and Description
public
Email(String address)

Method Summary

Modifier and TypeMethod and Description
public String
Inherited from net.fortuna.ical4j.model.Parameter:
compareToequalsgetNamehashCodetoString

Field Detail

addressback to summary
private final String address
PARAMETER_NAMEback to summary
private static final String PARAMETER_NAME
serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Parameter.serialVersionUID.

Constructor Detail

Emailback to summary
public Email(String address)

Method Detail

getValueback to summary
public 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
net.fortuna.ical4j.model.parameter back to summary

public Class Email.Factory

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

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Email
createParameter(final String
a value to assign to the returned parameter
value
)

Implements net.fortuna.ical4j.model.ParameterFactory.createParameter.

Returns a parameter instance of the appropriate type with the specified value.

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

createParameterback to summary
public Email createParameter(final String value)

Implements net.fortuna.ical4j.model.ParameterFactory.createParameter.

Doc from net.fortuna.ical4j.model.ParameterFactory.createParameter.

Returns a parameter instance of the appropriate type with the specified value.

Parameters
value:String

a value to assign to the returned parameter

Returns:Email

a parameter instance, or null if this factory is unable to create an appropriate parameter

Annotations
@Override