@SupportedVersions(value=V4_0) 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(Member original)
Copy constructor.
|
Member(String uri)
Creates a member property.
|
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.
|
Member |
copy()
Creates a copy of this property object.
|
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<Pid> |
getPids()
Gets the list that stores this property's PID (property ID) parameter
values.
|
Integer |
getPref()
Gets this property's 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 |
setAltId(String altId)
Sets the property's ALTID parameter.
|
void |
setMediaType(String mediaType)
Sets the MEDIATYPE parameter.
|
void |
setPref(Integer pref)
Sets this property's preference value.
|
void |
setUri(String uri)
Sets the URI.
|
static Member |
telephone(TelUri telUri)
Creates a member property whose value is a telephone number.
|
equals, getValue, hashCode, setValue, toStringValues
addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, isSupportedBy, removeParameter, setGroup, setParameter, setParameters, toString, 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 String getUri()
public List<Pid> getPids()
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
public Integer getPref()
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
public void setPref(Integer pref)
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
pref
- the preference value or null to removepublic 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<ValidationWarning> 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 topublic Member copy()
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
).
copy
in class VCardProperty
Copyright © 2012–2023 Michael Angstadt. All rights reserved.