public class Categories extends TextListProperty implements HasAltId
Defines a list of keywords that can be used to describe the person.
Code sample
VCard vcard = new VCard(); Categories categories = new Categories(); categories.addValue("Developer"); categories.addValue("Java coder"); categories.addValue("Ladies' man"); vcard.setCategories(categories);
Property name: CATEGORIES
Supported versions: 3.0, 4.0
values
group, parameters
Constructor and Description |
---|
Categories() |
Modifier and Type | Method and Description |
---|---|
Set<VCardVersion> |
_supportedVersions()
Gets the vCard versions that support this property.
|
void |
addPid(int localId,
int clientPidMapRef)
Adds a PID value.
|
String |
getAltId()
Gets the property's ALTID 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 |
setPref(Integer pref)
Sets the preference value.
|
void |
setType(String type)
Sets the TYPE parameter.
|
_validate, addValue, getValues, removeValue
addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate
public List<Integer[]> getPids()
VCardProperty
Gets all PID values.
Supported versions: 4.0
VCardParameters.getPids()
public void addPid(int localId, int clientPidMapRef)
VCardProperty
Adds a PID value.
Supported versions: 4.0
localId
- the local IDclientPidMapRef
- the ID used to reference the property's globally
unique identifier in the CLIENTPIDMAP property.VCardParameters.addPid(int, int)
public void removePids()
VCardProperty
Removes all PID values.
Supported versions: 4.0
VCardParameters.removePids()
public Integer getPref()
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
VCardParameters.getPref()
public void setPref(Integer pref)
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
pref
- the preference value or null to removeVCardParameters.setPref(java.lang.Integer)
public 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 getType()
Supported versions: 4.0
public void setType(String type)
Supported versions: 4.0
type
- the TYPE value (this should be either "work" or "home") or
null to removepublic Set<VCardVersion> _supportedVersions()
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.
_supportedVersions
in class VCardProperty
This software is published under the BSD license. Copyright © 2003-${build.year}, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.