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.addType(EmailType.HOME); vcard.addEmail(email); email = new Email("jdoe@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
value
group, parameters
Constructor and Description |
---|
Email(java.lang.String email)
Creates an email property.
|
Modifier and Type | Method and Description |
---|---|
protected void |
_validate(java.util.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.
|
java.lang.String |
getAltId()
Gets the property's ALTID parameter.
|
java.util.List<java.lang.Integer[]> |
getPids()
Gets all PID values.
|
java.lang.Integer |
getPref()
Gets the preference value.
|
java.util.Set<EmailType> |
getTypes()
Gets all the TYPE parameters.
|
void |
removePids()
Removes all PID values.
|
void |
removeType(EmailType type)
Removes a TYPE parameter.
|
void |
setAltId(java.lang.String altId)
Sets the property's ALTID parameter.
|
void |
setPref(java.lang.Integer pref)
Sets the preference value.
|
getValue, setValue
_supportedVersions, addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate
public Email(java.lang.String email)
email
- the email (e.g. "johndoe@example.com")public java.util.Set<EmailType> getTypes()
public void addType(EmailType type)
type
- the TYPE parameter to addpublic void removeType(EmailType type)
type
- the TYPE parameter to removepublic java.util.List<java.lang.Integer[]> getPids()
VCardProperty
Gets all PID values.
Supported versions: 4.0
VCardParameters.getPids()
public void addPid(int localId, int clientPidMapRef)
VCardProperty
Adds a PID value.
Supported versions: 4.0
localId
- the local IDclientPidMapRef
- the ID used to reference the property's globally
unique identifier in the CLIENTPIDMAP property.VCardParameters.addPid(int, int)
public void removePids()
VCardProperty
Removes all PID values.
Supported versions: 4.0
VCardParameters.removePids()
public java.lang.Integer getPref()
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
VCardParameters.getPref()
public void setPref(java.lang.Integer pref)
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
pref
- the preference value or null to removeVCardParameters.setPref(java.lang.Integer)
public java.lang.String getAltId()
HasAltId
Supported versions: 4.0
getAltId
in interface HasAltId
VCardParameters.getAltId()
public void setAltId(java.lang.String altId)
HasAltId
Supported versions: 4.0
setAltId
in interface HasAltId
altId
- the ALTID or null to removeVCardParameters.setAltId(java.lang.String)
protected void _validate(java.util.List<Warning> warnings, VCardVersion version, VCard vcard)
VCardProperty
_validate
in class SimpleProperty<java.lang.String>
warnings
- the list to add the warnings toversion
- the version to check the property againstvcard
- the vCard this property belongs toThis software is published under the BSD license. Copyright © 2003-${build.year}, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.