public class SortString extends TextProperty
Defines the string that should be used when an application sorts this vCard in some way.
This property is not supported in 4.0. Instead, use the
StructuredName.setSortAs(java.lang.String)
and/or Organization.setSortAs(java.lang.String...)
methods when creating version 4.0 vCards.
Code sample (3.0)
VCard vcard = new VCard(); StructuredName n = new StructuredName(); n.setFamily("d'Armour"); n.setGiven("Miles"); vcard.setStructuredName(n); SortString sortString = new SortString("Armour"); vcard.setSortString(sortString);
Code sample (4.0)
VCard vcard = new VCard(); StructuredName n = new StructuredName(); n.setFamily("d'Armour"); n.setGiven("Miles"); n.setSortAs("Armour"); vcard.setStructuredName(n);
Property name: SORT-STRING
Supported versions: 3.0
value
group, parameters
Constructor and Description |
---|
SortString(String sortString)
Creates a sort-string property.
|
Modifier and Type | Method and Description |
---|---|
Set<VCardVersion> |
_supportedVersions()
Gets the vCard versions that support this property.
|
_validate, getValue, setValue
addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate
public SortString(String sortString)
sortString
- the sort stringpublic 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.