ezvcard.property
Class Member

java.lang.Object
  ezvcard.property.VCardProperty
      ezvcard.property.SimpleProperty<String>
          ezvcard.property.TextProperty
              ezvcard.property.UriProperty
                  ezvcard.property.Member

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

public class Member
extends UriProperty
implements HasAltId

The members that make up the group. This property can only be used if the Kind property is set to "group".

Adding members

 VCard vcard = new VCard();
 
 //KIND must be set to "group" in order to add MEMBERs
 vcard.setKind(Kind.group());
 
 Member member = new Member();
 member.setUriEmail("funkyjoe@hotmail.com");
 vcard.addMember(member);
 member = new Member();
 member.setUriIM("aol", "joesmoe@aol.com");
 vcard.addMember(member);
 member = new Member();
 member.setUriTelephone("+1-123-555-6789");
 vcard.addMember(member);
 member = new Member();
 member.setUri("urn:uuid:03a0e51f-d1aa-4385-8a53-e29025acd8af"); //references the UID from another vCard
 vcard.addMember(member);
 

Getting members

 VCard vcard = ...
 Kind kind = vcard.getKind();
 if (kind != null){
   if (kind.isGroup()){
     System.out.println("The group's members are:");
     for (Member member : vcard.getMembers()){
       System.out.println(member.getUri());
     }
   }
 }
 

Property name: MEMBER

Supported versions: 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

Member(String uri)
Creates a member property.

Method Summary

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.
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.
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.
void	setUriEmail(String email) Sets the URI to an email address.
void	setUriIM(String protocol, String handle) Sets the URI to an instant messaging handle.
void	setUriTelephone(String telephone) Sets the URI to a telephone number.

Methods inherited from class ezvcard.property.SimpleProperty

getValue, setValue

Methods inherited from class ezvcard.property.VCardProperty

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

Member

public Member(String uri)

Creates a member property.

Parameters:

uri - the URI representing the member

Method Detail

_supportedVersions

public Set<VCardVersion> _supportedVersions()

Description copied from class: 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.

Overrides:

_supportedVersions in class VCardProperty

Returns:

the vCard versions that support this property.

getUri

public String getUri()

Gets the URI value.

Returns:

the URI value or null if no URI value is set

setUriEmail

public void setUriEmail(String email)

Sets the URI to an email address.

Parameters:

email - the email address

setUriIM

public void setUriIM(String protocol,
                     String handle)

Sets the URI to an instant messaging handle.

Parameters:

protocol - the IM protocol (e.g. "aim")

handle - the handle

setUriTelephone

public void setUriTelephone(String telephone)

Sets the URI to a telephone number.

Parameters:

telephone - the telephone number

setUri

public void setUri(String uri)

Sets the URI.

Parameters:

uri - the URI

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)

getMediaType

public String getMediaType()

Gets the MEDIATYPE parameter.

Supported versions: 4.0

Returns:

the media type or null if not set

setMediaType

public void setMediaType(String mediaType)

Sets the MEDIATYPE parameter.

Supported versions: 4.0

Parameters:

mediaType - the media type or null to remove

_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