Compoze Software, Inc.

com.compoze.exchange
Class AddressDisplayType

java.lang.Object
  extended bycom.compoze.exchange.AddressDisplayType
All Implemented Interfaces:
java.io.Serializable

public class AddressDisplayType
extends java.lang.Object
implements java.io.Serializable

This class stores the values for a address 'display type'. The internationalizable string values are stored in the exchange_resources.properties file (accessed through ExchangeProperties) and referenced by their key.

See Also:
Serialized Form

Field Summary
static AddressDisplayType AGENT
          This value represents a 'agent' display type.
static AddressDisplayType DIST_LIST
          This value represents a 'distribution list' display type.
static AddressDisplayType FORUM
          This value represents a 'forum' display type.
static AddressDisplayType ORGANIZATION
          This value represents a 'organization' display type.
static AddressDisplayType PRIVATE_DIST_LIST
          This value represents a 'private distribution list' display type.
static AddressDisplayType REMOTE_USER
          This value represents a 'remote user' display type (a remote messaging user).
static AddressDisplayType USER
          This value represents a 'user' display type (a local messaging user).
 
Method Summary
 boolean equals(java.lang.Object o)
          Checks for equality.
static AddressDisplayType get(int iStoreValue)
          Gets the display type by its store value.
static java.util.List getList()
          Gets the list of display types.
 java.lang.String getName()
          Gets the name of the display type using the system default locale.
 java.lang.String getName(java.util.Locale locale)
          Gets the name of the display type using the specified locale.
 int getStoreValue()
          Gets the value that's used to store the display type in the storage system.
 java.lang.String toString()
          Returns a string representation of the object.
 java.lang.String toString(java.util.Locale locale)
          Returns a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

USER

public static final AddressDisplayType USER
This value represents a 'user' display type (a local messaging user).


DIST_LIST

public static final AddressDisplayType DIST_LIST
This value represents a 'distribution list' display type.


FORUM

public static final AddressDisplayType FORUM
This value represents a 'forum' display type.


AGENT

public static final AddressDisplayType AGENT
This value represents a 'agent' display type.


ORGANIZATION

public static final AddressDisplayType ORGANIZATION
This value represents a 'organization' display type.


PRIVATE_DIST_LIST

public static final AddressDisplayType PRIVATE_DIST_LIST
This value represents a 'private distribution list' display type.


REMOTE_USER

public static final AddressDisplayType REMOTE_USER
This value represents a 'remote user' display type (a remote messaging user).

Method Detail

getName

public java.lang.String getName()
Gets the name of the display type using the system default locale.

Returns:
the name

getName

public java.lang.String getName(java.util.Locale locale)
Gets the name of the display type using the specified locale.

Parameters:
locale - the locale
Returns:
the name

getStoreValue

public int getStoreValue()
Gets the value that's used to store the display type in the storage system.

Returns:
the store value

get

public static AddressDisplayType get(int iStoreValue)
Gets the display type by its store value.

Parameters:
iStoreValue - the store value to get by
Returns:
the matching display type or null if not found

getList

public static java.util.List getList()
Gets the list of display types.

Returns:
the list of AddressDisplayTypes (unmodifiable)

equals

public boolean equals(java.lang.Object o)
Checks for equality. The store value is used to determine equality, so that the language the name is represented in is not important.

Parameters:
o - the object to check
Returns:
true if this object has the same store value as the argument, false otherwise

toString

public java.lang.String toString()
Returns a string representation of the object.

Returns:
the string representation of the object

toString

public java.lang.String toString(java.util.Locale locale)
Returns a string representation of the object.

Parameters:
locale - the locale
Returns:
the string representation of the object

Compoze Software, Inc.

Copyright ©1999-2003 Compoze Software, Inc. All rights reserved.