ezvcard.types
Class UrlType

java.lang.Object
  ezvcard.types.VCardType
      ezvcard.types.TextType
          ezvcard.types.UriType
              ezvcard.types.UrlType

All Implemented Interfaces:

HasAltId, Comparable<VCardType>

public class UrlType
extends UriType
implements HasAltId

A URL pointing to the person's homepage or business website.

Code sample

 VCard vcard = new VCard();
 UrlType url = new UrlType("http://www.company.com");
 vcard.addUrl(url);
 

Property name: URL

Supported versions: 2.1, 3.0, 4.0

Author:

Michael Angstadt

Field Summary

static String

NAME

Fields inherited from class ezvcard.types.TextType

value

Fields inherited from class ezvcard.types.VCardType

group, subTypes, typeName

Constructor Summary

UrlType()
Creates an empty URL property.

UrlType(String url)
Creates a URL property.

Method Summary

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	getType() Gets the TYPE parameter.
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	setType(String type) Sets the TYPE parameter.

Methods inherited from class ezvcard.types.UriType

doMarshalJson, doMarshalXml, doUnmarshalHtml, doUnmarshalXml

Methods inherited from class ezvcard.types.TextType

doMarshalText, doUnmarshalJson, doUnmarshalText, getValue, setValue

Methods inherited from class ezvcard.types.VCardType

compareTo, doMarshalSubTypes, getGroup, getQName, getSubTypes, getSupportedVersions, getTypeName, marshalJson, marshalSubTypes, marshalText, marshalXml, setGroup, unmarshalHtml, unmarshalJson, unmarshalText, unmarshalXml

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

UrlType

public UrlType()

Creates an empty URL property.

UrlType

public UrlType(String url)

Creates a URL property.

Parameters:

url - the URL (e.g. "http://example.com")

Method Detail

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

getPids

public List<Integer[]> getPids()

Description copied from class: VCardType

Gets all PID values.

Supported versions: 4.0

Returns:

the PID values or empty set if there are none

See Also:

VCardSubTypes.getPids()

addPid

public void addPid(int localId,
                   int clientPidMapRef)

Description copied from class: VCardType

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:

VCardSubTypes.addPid(int, int)

removePids

public void removePids()

Description copied from class: VCardType

Removes all PID values.

Supported versions: 4.0

See Also:

VCardSubTypes.removePids()

getPref

public Integer getPref()

Description copied from class: VCardType

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:

VCardSubTypes.getPref()

setPref

public void setPref(Integer pref)

Description copied from class: VCardType

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:

VCardSubTypes.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:

VCardSubTypes.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:

VCardSubTypes.setAltId(java.lang.String)

getType

public String getType()

Gets the TYPE parameter.

Supported versions: 4.0*

* Some mail clients will add this parameter to URL types in 2.1 and 3.0 vCards, however.

Returns:

the TYPE value (typically, this will be either "work" or "home") or null if it doesn't exist

setType

public void setType(String type)

Sets the TYPE parameter.

Supported versions: 4.0*

* Some mail clients will add this parameter to URL types in 2.1 and 3.0 vCards, however.

Parameters:

type - the TYPE value (this should be either "work" or "home") or null to remove