PrincipalCollationKeyFactory

java.lang.Object

wt.util.CollationKeyFactory

wt.org.PrincipalCollationKeyFactory

public final class PrincipalCollationKeyFactory extends CollationKeyFactory

A collation key factory for Principals

Supported API: true
Extendable: false

Constructor Summary

Constructors

Constructor

Description

PrincipalCollationKeyFactory()

Construct a collation key factory for the current WTContext's locale.

PrincipalCollationKeyFactory(Locale locale)

Construct a collation key factory for the given locale.
Method Summary

Modifier and Type

Method

Description

String

getCollationString(Object obj)

Get a collation string for the given object.

Methods inherited from class wt.util.CollationKeyFactory
getKey, getLocale

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- PrincipalCollationKeyFactory
  
  public PrincipalCollationKeyFactory()
  
  Construct a collation key factory for the current WTContext's locale.
  
  Supported API: true
  Extendable: false
- PrincipalCollationKeyFactory
  
  public PrincipalCollationKeyFactory(Locale locale)
  
  Construct a collation key factory for the given locale.
  
  Parameters:
  
  locale - desired locale
  
  Supported API: true
  Extendable: false
Method Details
- getCollationString
  
  public String getCollationString(Object obj)
  
  Get a collation string for the given object. Principals will be sorted by name.
  
  Overrides:
  
  getCollationString in class CollationKeyFactory
  
  Parameters:
  
  obj - the object that will be part of the sorted results
  
  Supported API: true
  Extendable: false
  
  Returns:
  
  string collation key source string