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

An email address associated with a person.

Code sample

 VCard vcard = new VCard();
 
 Email email = new Email("superdude55@hotmail.com");
 email.addType(EmailType.HOME);
 vcard.addEmail(email);
 
 email = new Email("doe.john@company.com");
 email.addType(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

Field Summary

Fields inherited from class ezvcard.property.SimpleProperty

value

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Email(String email)
Creates an email property.

Method Summary

protected void	_validate(List<Warning> warnings, VCardVersion version, VCard vcard) Checks the property for data consistency problems or deviations from the spec.
void	addPid(int localId, int clientPidMapRef) Adds a PID value.
void	addType(EmailType type) Adds a TYPE parameter.
String	getAltId() Gets the property's ALTID parameter.
List<Integer[]>	getPids() Gets all PID values.
Integer	getPref() Gets the preference value.
Set<EmailType>	getTypes() Gets all the TYPE parameters.
void	removePids() Removes all PID values.
void	removeType(EmailType type) Removes a TYPE parameter.
void	setAltId(String altId) Sets the property's ALTID parameter.
void	setPref(Integer pref) Sets the preference value.

Methods inherited from class ezvcard.property.SimpleProperty

getValue, setValue

Methods inherited from class ezvcard.property.VCardProperty

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Email

public Email(String email)

Creates an email property.

Parameters:

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

Method Detail

getTypes

public Set<EmailType> getTypes()

Gets all the TYPE parameters.

Returns:

the TYPE parameters or empty set if there are none

addType

public void addType(EmailType type)

Adds a TYPE parameter.

Parameters:

type - the TYPE parameter to add

removeType

public void removeType(EmailType type)

Removes a TYPE parameter.

Parameters:

type - the TYPE parameter to remove

getPids

public List<Integer[]> getPids()

Description copied from class: VCardProperty

Gets all PID values.

Supported versions: 4.0

Returns:

the PID values or empty set if there are none

See Also:

VCardParameters.getPids()

addPid

public void addPid(int localId,
                   int clientPidMapRef)

Description copied from class: VCardProperty

Adds a PID value.

Supported versions: 4.0

Parameters:

localId - the local ID

clientPidMapRef - the ID used to reference the property's globally unique identifier in the CLIENTPIDMAP property.

See Also:

VCardParameters.addPid(int, int)

removePids

public void removePids()

Description copied from class: VCardProperty

Removes all PID values.

Supported versions: 4.0

See Also:

VCardParameters.removePids()

getPref

public Integer getPref()

Description copied from class: VCardProperty

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

Supported versions: 4.0

Returns:

the preference value or null if it doesn't exist

See Also:

VCardParameters.getPref()

setPref

public void setPref(Integer pref)

Description copied from class: VCardProperty

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

Supported versions: 4.0

Parameters:

pref - the preference value or null to remove

See Also:

VCardParameters.setPref(java.lang.Integer)

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<Warning> 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