ezvcard.property
Class SortString

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

All Implemented Interfaces:

Comparable<VCardProperty>

public class SortString
extends TextProperty

Defines a string that should be used when an application sorts this vCard in some way.

The SORT-STRING property is not supported in 4.0. Instead, use the StructuredName.setSortAs(java.lang.String) and/or Organization.setSortAs(java.lang.String...) methods.

Code sample (2.1, 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: 2.1, 3.0

Author:

Michael Angstadt

Field Summary

Fields inherited from class ezvcard.property.SimpleProperty

value

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

SortString(String sortString)
Creates a sort-string property.

Method Summary

Set<VCardVersion>

_supportedVersions() Gets the vCard versions that support this property.

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

SortString

public SortString(String sortString)

Creates a sort-string property.

Parameters:

sortString - the sort string

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.