public class Member extends UriProperty implements HasAltId
Defines the members that make up the group. This property can only be used if
the vCard's Kind
property is set to "group".
Code sample
VCard vcard = new VCard(); //kind property must be set to "group" in order to add members vcard.setKind(Kind.group()); //static factory methods Member member = Member.email("johndoe@hotmail.com"); vcard.addMember(member); //reference another vCard by putting its UID property here member = new Member("urn:uuid:03a0e51f-d1aa-4385-8a53-e29025acd8af"); vcard.addMember(member);
Property name: MEMBER
Supported versions: 4.0
value
group, parameters
Constructor and Description |
---|
Member(String uri)
Creates a member property.
|
Modifier and Type | Method and Description |
---|---|
Set<VCardVersion> |
_supportedVersions()
Gets the vCard versions that support this property.
|
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.
|
static Member |
email(String email)
Creates a member property whose value is an email address.
|
String |
getAltId()
Gets the property's ALTID parameter.
|
String |
getMediaType()
Gets the MEDIATYPE parameter.
|
List<Integer[]> |
getPids()
Gets all PID values.
|
Integer |
getPref()
Gets the preference value.
|
String |
getUri()
Gets the URI value.
|
static Member |
im(String protocol,
String handle)
Creates a member property whose value is an instant messenger handle.
|
void |
removePids()
Removes all PID values.
|
void |
setAltId(String altId)
Sets the property's ALTID parameter.
|
void |
setMediaType(String mediaType)
Sets the MEDIATYPE parameter.
|
void |
setPref(Integer pref)
Sets the preference value.
|
void |
setUri(String uri)
Sets the URI.
|
static Member |
telephone(TelUri telUri)
Creates a member property whose value is a telephone number.
|
getValue, setValue
addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate
public Member(String uri)
uri
- the URI representing the memberpublic static Member email(String email)
email
- the email addresspublic static Member im(String protocol, String handle)
protocol
- the instant messenger protocol (e.g. "aim")handle
- the instant messenger handle (e.g. "johndoe")public static Member telephone(TelUri telUri)
telUri
- the telephone numberpublic Set<VCardVersion> _supportedVersions()
VCardProperty
Gets the vCard versions that support this property.
This method should be overridden by child classes if the property does not support all vCard versions. The default implementation of this method returns all vCard versions.
_supportedVersions
in class VCardProperty
public String getUri()
public void setUri(String uri)
uri
- the URIpublic List<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 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(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 String getAltId()
HasAltId
Supported versions: 4.0
getAltId
in interface HasAltId
VCardParameters.getAltId()
public void setAltId(String altId)
HasAltId
Supported versions: 4.0
setAltId
in interface HasAltId
altId
- the ALTID or null to removeVCardParameters.setAltId(java.lang.String)
public String getMediaType()
Supported versions: 4.0
public void setMediaType(String mediaType)
Supported versions: 4.0
mediaType
- the media type or null to removeprotected void _validate(List<Warning> warnings, VCardVersion version, VCard vcard)
VCardProperty
_validate
in class SimpleProperty<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.