rocks.xmpp.extensions.vcard.temp.model

Class VCard

java.lang.Object

rocks.xmpp.extensions.vcard.temp.model.VCard

public final class VCard
extends Object

The implementation of the <vCard/> element in the vcard-temp namespace.

Author:

Christian Schudt

See Also:

XEP-0054: vcard-temp, DTD

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VCard.Address Represents structured address data.
static class	VCard.AddressLabel Represents the formatted text corresponding to a delivery address.
static class	VCard.Classification
static class	VCard.Email Represents an email address.
static class	VCard.Geo Stores information related to the global positioning.
static class	VCard.Image Represents an image.
static class	VCard.Key Represents an authentication credential or encryption key.
static class	VCard.Name Represents a name.
static class	VCard.Organization Represents an organization.
static class	VCard.Sound Represents an image.
static class	VCard.TelephoneNumber Represents a telephone number.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE

Constructor Summary

Constructors

Constructor and Description
VCard()

Method Summary

Modifier and Type	Method and Description
List<VCard.Address>	getAddresses() Gets the addresses.
String	getAgent() Gets information about another person who will act on behalf of the individual or resource associated with the vCard.
Date	getBirthday() Gets the birthday.
List<String>	getCategories() Gets application category information about the vCard.
VCard.Classification	getClassification()
String	getDesc() Gets free-form descriptive text.
List<VCard.Email>	getEmails() Gets the email addresses.
String	getFormattedName() Gets the formatted text corresponding to the name.
VCard.Geo	getGeo() Gets information related to the global positioning of the object the vCard represents.
Jid	getJid() Gets the JID.
VCard.Key	getKey() Gets the authentication credential or encryption key.
List<VCard.AddressLabel>	getLabels() Gets the labels.
VCard.Image	getLogo() Gets the logo.
String	getMailer() Gets the type of electronic mail software that is used by the individual associated with the vCard.
VCard.Name	getName() Gets the name.
String	getNickName() Gets the nick name.
String	getNote() Gets supplemental information or a comment that is associated with the vCard.
VCard.Organization	getOrganization() Gets the organization.
VCard.Image	getPhoto() Gets the photo.
String	getProductId() Gets the identifier for the product that created the vCard object.
Date	getRevision() Gets revision information about the current vCard.
String	getRole() Gets information concerning the role, occupation, or business category of the object the vCard represents.
String	getSortString() Gets the sort string, specifying the family name or given name text to be used for national-language-specific sorting of the FN and N types.
String	getSound() Gets the sound, zo specify a digital sound content information that annotates some aspect of the vCard.
List<VCard.TelephoneNumber>	getTelephoneNumbers() Gets the telephone numbers.
String	getTimeZone() Gets the time zone.
String	getTitle() Gets the job title, functional position or function of the object the vCard represents.
String	getUid() Gets the UID, to specify a value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard.
URL	getUrl() Gets an URL associated with the object that the vCard refers to.
void	setAgent(String agent) Sets the agent.
void	setBirthday(Date birthday) Sets the birthday.
void	setClassification(VCard.Classification classification)
void	setDesc(String desc) Sets free-form descriptive text.
void	setFormattedName(String formattedName) Sets the formatted name.
void	setGeo(VCard.Geo geo) Sets the geo location.
void	setJid(Jid jid) Sets the JID.
void	setKey(VCard.Key key) Sets the authentication credential or encryption key.
void	setLogo(VCard.Image logo) Sets the logo.
void	setMailer(String mailer) Sets the mailer.
void	setName(VCard.Name name) Sets the name.
void	setNickName(String nickName) Sets the nick name.
void	setNote(String note) Sets a note.
void	setOrganization(VCard.Organization organization) Sets the organization.
void	setPhoto(VCard.Image photo) Sets the photo.
void	setProductId(String productId) Sets the product id.
void	setRevision(Date revision) Sets revision information.
void	setRole(String role) Sets the role.
void	setSortString(String sortString) Sets the sort string.
void	setSound(String sound) Sets the sound.
void	setTimeZone(String timezone) Sets the time zone.
void	setTitle(String title) Sets the title.
void	setUid(String uid) Sets the UID.
void	setUrl(URL url) Sets an URL.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

VCard

public VCard()

Method Detail

getFormattedName

public String getFormattedName()

Gets the formatted text corresponding to the name.

Returns:

The formatted name.

See Also:

setFormattedName(String)

setFormattedName

public void setFormattedName(String formattedName)

Sets the formatted name.

Parameters:

formattedName - The formatted name.

See Also:

getFormattedName()

getName

public VCard.Name getName()

Gets the name.

Returns:

The name.

See Also:

setName(VCard.Name)

setName

public void setName(VCard.Name name)

Sets the name.

Parameters:

name - The name.

See Also:

getName()

getNickName

public String getNickName()

Gets the nick name.

Returns:

The nick name.

See Also:

setNickName(String)

setNickName

public void setNickName(String nickName)

Sets the nick name.

Parameters:

nickName - The nick name.

See Also:

getNickName()

getPhoto

public VCard.Image getPhoto()

Gets the photo.

Returns:

Either a URL to a photo or a base64 encoded photo.

See Also:

setPhoto(VCard.Image)

setPhoto

public void setPhoto(VCard.Image photo)

Sets the photo.

Parameters:

photo - The photo.

See Also:

getPhoto()

getBirthday

public Date getBirthday()

Gets the birthday.

Code sample:

 
 Calendar calendar = new GregorianCalendar();
 calendar.setTime(vCard.getBirthday());
 int year = calendar.get(Calendar.YEAR);
 int month = calendar.get(Calendar.MONTH);
 int day = calendar.get(Calendar.DATE);
 
 

Returns:

The birth day.

See Also:

setBirthday(java.util.Date)

setBirthday

public void setBirthday(Date birthday)

Sets the birthday.

 
 Calendar calendar = new GregorianCalendar();
 calendar.set(Calendar.YEAR, 2004);
 calendar.set(Calendar.MONTH, Calendar.MARCH);
 calendar.set(Calendar.DATE, 19);
 vCard.setBirthday(calendar.getTime());
 
 

Parameters:

birthday - The birthday.

See Also:

getBirthday()

getUrl

public URL getUrl()

Gets an URL associated with the object that the vCard refers to.

Returns:

The URL.

See Also:

setUrl(java.net.URL)

setUrl

public void setUrl(URL url)

Sets an URL.

Parameters:

url - The URL.

See Also:

getUrl()

getOrganization

public VCard.Organization getOrganization()

Gets the organization.

Returns:

The organization.

See Also:

setOrganization(VCard.Organization)

setOrganization

public void setOrganization(VCard.Organization organization)

Sets the organization.

Parameters:

organization - The organization.

See Also:

getOrganization()

getAddresses

public List<VCard.Address> getAddresses()

Gets the addresses.

Returns:

The addresses.

getTelephoneNumbers

public List<VCard.TelephoneNumber> getTelephoneNumbers()

Gets the telephone numbers.

Returns:

The telephone numbers.

getEmails

public List<VCard.Email> getEmails()

Gets the email addresses.

Returns:

The email addresses.

getLabels

public List<VCard.AddressLabel> getLabels()

Gets the labels.

Returns:

The labels.

getJid

public Jid getJid()

Gets the JID.

Returns:

The JID.

See Also:

setJid(rocks.xmpp.core.Jid)

setJid

public void setJid(Jid jid)

Sets the JID.

Parameters:

jid - The JID.

See Also:

getJid()

getMailer

public String getMailer()

Gets the type of electronic mail software that is used by the individual associated with the vCard.

Returns:

The mailer.

See Also:

setMailer(String)

setMailer

public void setMailer(String mailer)

Sets the mailer.

Parameters:

mailer - The mailer.

See Also:

getMailer()

getTimeZone

public String getTimeZone()

Gets the time zone.

Returns:

The time zone.

See Also:

setTimeZone(String)

setTimeZone

public void setTimeZone(String timezone)

Sets the time zone.

Parameters:

timezone - The time zone.

See Also:

getTimeZone()

getGeo

public VCard.Geo getGeo()

Gets information related to the global positioning of the object the vCard represents.

Returns:

The geo location.

See Also:

setGeo(VCard.Geo)

setGeo

public void setGeo(VCard.Geo geo)

Sets the geo location.

Parameters:

geo - The geo location.

See Also:

getGeo()

getTitle

public String getTitle()

Gets the job title, functional position or function of the object the vCard represents.

Returns:

The title.

See Also:

setTitle(String)

setTitle

public void setTitle(String title)

Sets the title.

Parameters:

title - The title.

See Also:

getTitle()

getRole

public String getRole()

Gets information concerning the role, occupation, or business category of the object the vCard represents.

Returns:

The role.

See Also:

setRole(String)

setRole

public void setRole(String role)

Sets the role.

Parameters:

role - The role.

See Also:

getRole()

getAgent

public String getAgent()

Gets information about another person who will act on behalf of the individual or resource associated with the vCard.

Returns:

The agent.

See Also:

setAgent(String)

setAgent

public void setAgent(String agent)

Sets the agent.

Parameters:

agent - The agent.

See Also:

getAgent()

getLogo

public VCard.Image getLogo()

Gets the logo.

Returns:

Either an URL to an image or a base64 encoded image.

See Also:

setLogo(VCard.Image)

setLogo

public void setLogo(VCard.Image logo)

Sets the logo.

Parameters:

logo - The logo.

See Also:

getLogo()

getCategories

public List<String> getCategories()

Gets application category information about the vCard.

Returns:

The categories.

getNote

public String getNote()

Gets supplemental information or a comment that is associated with the vCard.

Returns:

The note.

See Also:

setNote(String)

setNote

public void setNote(String note)

Sets a note.

Parameters:

note - The note.

See Also:

getNote()

getProductId

public String getProductId()

Gets the identifier for the product that created the vCard object.

Returns:

The product id.

See Also:

setProductId(String)

setProductId

public void setProductId(String productId)

Sets the product id.

Parameters:

productId - The product id.

See Also:

getProductId()

getRevision

public Date getRevision()

Gets revision information about the current vCard.

Returns:

The revision.

See Also:

setRevision(java.util.Date)

setRevision

public void setRevision(Date revision)

Sets revision information.

Parameters:

revision - The revision information.

See Also:

getRevision()

getSortString

public String getSortString()

Gets the sort string, specifying the family name or given name text to be used for national-language-specific sorting of the FN and N types.

Returns:

The sort string.

See Also:

setSortString(String)

setSortString

public void setSortString(String sortString)

Sets the sort string.

Parameters:

sortString - The sort string.

See Also:

getSortString()

getSound

public String getSound()

Gets the sound, zo specify a digital sound content information that annotates some aspect of the vCard. By default this type is used to specify the proper pronunciation of the name type value of the vCard.

Returns:

The sound, either as pronunciation string, as URL or as base64 encoded binary.

See Also:

setSound(String)

setSound

public void setSound(String sound)

Sets the sound.

Parameters:

sound - The sound.

See Also:

getSound()

getUid

public String getUid()

Gets the UID, to specify a value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard.

Returns:

The UID.

See Also:

setUid(String)

setUid

public void setUid(String uid)

Sets the UID.

Parameters:

uid - The UID.

See Also:

getUid()

getKey

public VCard.Key getKey()

Gets the authentication credential or encryption key.

Returns:

The key.

See Also:

setKey(VCard.Key)

setKey

public void setKey(VCard.Key key)

Sets the authentication credential or encryption key.

Parameters:

key - The key.

See Also:

getKey()

getDesc

public String getDesc()

Gets free-form descriptive text.

Returns:

The descriptive text.

See Also:

setDesc(String)

setDesc

public void setDesc(String desc)

Sets free-form descriptive text.

Parameters:

desc - The descriptive text.

See Also:

getDesc()

getClassification

public VCard.Classification getClassification()

setClassification

public void setClassification(VCard.Classification classification)