ezvcard.property
Class OrgDirectory

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

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

public class OrgDirectory
extends UriProperty
implements HasAltId

Defines a URI representing the person's work place, which can be used to lookup information on the person's co-workers.

Code sample

 VCard vcard = new VCard();
 OrgDirectory orgDirectory = new OrgDirectory("http://www.company.com/staff");
 vcard.addOrgDirectory(orgDirectory);
 

Property name: ORG-DIRECTORY

Supported versions: 4.0

Author:

Michael Angstadt

See Also:

RFC 6715

Field Summary

Fields inherited from class ezvcard.property.SimpleProperty

value

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

OrgDirectory(String uri)

Method Summary

Set<VCardVersion>	_supportedVersions() Gets the vCard versions that support this property.
String	getAltId() Gets the property's ALTID parameter.
Integer	getIndex() Gets the sorted position of this property when it is grouped together with other properties of the same type.
String	getLanguage() Gets the language that the property value is written in.
Integer	getPref() Gets the preference value.
String	getType() Gets the TYPE parameter.
void	setAltId(String altId) Sets the property's ALTID parameter.
void	setIndex(Integer index) Sets the sorted position of this property when it is grouped together with other properties of the same type.
void	setLanguage(String language) Sets the language that the property value is written in.
void	setPref(Integer pref) Sets the preference value.
void	setType(String type) Sets the TYPE parameter.

Methods inherited from class ezvcard.property.SimpleProperty

_validate, 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

OrgDirectory

public OrgDirectory(String uri)

Parameters:

uri - the URI

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.

getIndex

public Integer getIndex()

Description copied from class: VCardProperty

Gets the sorted position of this property when it is grouped together with other properties of the same type. Properties with low index values are put at the beginning of the sorted list and properties with high index values are put at the end of the list.

Returns:

the index or null if not set

See Also:

VCardParameters.setIndex(java.lang.Integer)

setIndex

public void setIndex(Integer index)

Description copied from class: VCardProperty

Sets the sorted position of this property when it is grouped together with other properties of the same type. Properties with low index values are put at the beginning of the sorted list and properties with high index values are put at the end of the list.

Parameters:

index - the index or null to remove

See Also:

VCardParameters.setIndex(java.lang.Integer)

getType

public String getType()

Gets the TYPE parameter.

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.

Parameters:

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

getLanguage

public String getLanguage()

Description copied from class: VCardProperty

Gets the language that the property value is written in.

Returns:

the language or null if not set

See Also:

VCardParameters.getLanguage()

setLanguage

public void setLanguage(String language)

Description copied from class: VCardProperty

Sets the language that the property value is written in.

Parameters:

language - the language or null to remove

See Also:

VCardParameters.setLanguage(java.lang.String)

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)