ezvcard.property

Class Email

java.lang.Object

ezvcard.property.VCardProperty

ezvcard.property.SimpleProperty<String>

ezvcard.property.TextProperty

ezvcard.property.Email

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

public class Email
extends TextProperty
implements HasAltId

Defines an email address associated with the person.

Code sample

 VCard vcard = new VCard();
 
 Email email = new Email("johndoe@hotmail.com");
 email.getTypes().add(EmailType.HOME);
 vcard.addEmail(email);
 
 email = new Email("jdoe@company.com");
 email.getTypes().add(EmailType.WORK);
 email.setPref(1); //the most preferred email
 vcard.addEmail(email);
 

Property name: EMAIL

Supported versions: 2.1, 3.0, 4.0

Author:

Michael Angstadt

See Also:

RFC 6350 p.36, RFC 2426 p.15, vCard 2.1 p.15

Field Summary

Fields inherited from class ezvcard.property.SimpleProperty

value

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
Email(Email original) Copy constructor.
Email(String email) Creates an email property.

Method Summary

Modifier and Type	Method and Description
protected void	_validate(List<ValidationWarning> warnings, VCardVersion version, VCard vcard) Checks the property for data consistency problems or deviations from the spec.
Email	copy() Creates a copy of this property object.
String	getAltId() Gets the property's ALTID parameter.
List<Pid>	getPids() Gets the list that stores this property's PID (property ID) parameter values.
Integer	getPref() Gets this property's preference value.
List<EmailType>	getTypes() Gets the list that stores this property's email types (TYPE parameters).
void	setAltId(String altId) Sets the property's ALTID parameter.
void	setPref(Integer pref) Sets this property's preference value.

Methods inherited from class ezvcard.property.SimpleProperty

equals, getValue, hashCode, setValue, toStringValues

Methods inherited from class ezvcard.property.VCardProperty

addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, isSupportedBy, removeParameter, setGroup, setParameter, setParameters, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Email

public Email(String email)

Creates an email property.

Parameters:

email - the email (e.g. "johndoe@example.com")

Email

public Email(Email original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getTypes

public List<EmailType> getTypes()

Gets the list that stores this property's email types (TYPE parameters).

Returns:

the email types (this list is mutable) (e.g. "INTERNET", "WORK")

getPids

public List<Pid> getPids()

Description copied from class: VCardProperty

Gets the list that stores this property's PID (property ID) parameter values.

PIDs can exist on any property where multiple instances are allowed (such as Email or Address, but not StructuredName because only 1 instance of this property is allowed per vCard).

When used in conjunction with the ClientPidMap property, it allows an individual property instance to be uniquely identifiable. This feature is made use of when two different versions of the same vCard have to be merged together (called "synchronizing").

Supported versions: 4.0

Returns:

the PID parameter values (this list is mutable)

See Also:

RFC 6350 p.19

getPref

public Integer getPref()

Description copied from class: VCardProperty

Gets this property's preference value. The lower this number is, the more "preferred" the property instance is compared with other properties of the same type. If a property doesn't have a preference value, then it is considered the least preferred.

In the vCard below, the Address on the second row is the most preferred because it has the lowest PREF value.

 ADR;TYPE=work;PREF=2:;;1600 Amphitheatre Parkway;Mountain View;CA;94043
 ADR;TYPE=work;PREF=1:;;One Microsoft Way;Redmond;WA;98052
 ADR;TYPE=home:;;123 Maple St;Hometown;KS;12345
 

Supported versions: 4.0

Returns:

the preference value or null if not set

See Also:

RFC 6350 p.17

setPref

public void setPref(Integer pref)

Description copied from class: VCardProperty

Sets this property's preference value. The lower this number is, the more "preferred" the property instance is compared with other properties of the same type. If a property doesn't have a preference value, then it is considered the least preferred.

In the vCard below, the Address on the second row is the most preferred because it has the lowest PREF value.

 ADR;TYPE=work;PREF=2:;;1600 Amphitheatre Parkway;Mountain View;CA;94043
 ADR;TYPE=work;PREF=1:;;One Microsoft Way;Redmond;WA;98052
 ADR;TYPE=home:;;123 Maple St;Hometown;KS;12345
 

Supported versions: 4.0

Parameters:

pref - the preference value or null to remove

See Also:

RFC 6350 p.17

getAltId

public String getAltId()

Description copied from interface: HasAltId

Gets the property's ALTID parameter.

Supported versions: 4.0

Specified by:

getAltId in interface HasAltId

Returns:

the ALTID or null if it doesn't exist

See Also:

VCardParameters.getAltId()

setAltId

public void setAltId(String altId)

Description copied from interface: HasAltId

Sets the property's ALTID parameter.

Supported versions: 4.0

Specified by:

setAltId in interface HasAltId

Parameters:

altId - the ALTID or null to remove

See Also:

VCardParameters.setAltId(java.lang.String)

_validate

protected void _validate(List<ValidationWarning> warnings,
                         VCardVersion version,
                         VCard vcard)

Description copied from class: VCardProperty

Checks the property for data consistency problems or deviations from the spec. Meant to be overridden by child classes that wish to provide validation logic.

Overrides:

_validate in class SimpleProperty<String>

Parameters:

warnings - the list to add the warnings to

version - the version to check the property against

vcard - the vCard this property belongs to

copy

public Email copy()

Description copied from class: VCardProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the VCardProperty.VCardProperty(VCardProperty) super constructor to ensure that the group name and parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the VCard class's copy constructor).

Overrides:

copy in class VCardProperty

Returns:

the copy