com.communote.server.core.user.helper

Enum UserNameFormat

java.lang.Object

java.lang.Enum<UserNameFormat>

com.communote.server.core.user.helper.UserNameFormat

All Implemented Interfaces:

Serializable, Comparable<UserNameFormat>

public enum UserNameFormat
extends Enum<UserNameFormat>

This enum provides the format definitions for a user signature.

Author:

Communote GmbH - http://www.communote.com/

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALIAS The signature of the user is "ALIAS"
LONG The signature of the user is "SALUTATIONS FIRSTNAME LASTNAME".
MEDIUM The signature of the user is "FIRSTNAME LASTNAME (ALIAS)".
SHORT The signature of the user is "FIRSTNAME LASTNAME".

Method Summary

Modifier and Type	Method and Description
static UserNameFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static UserNameFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALIAS

public static final UserNameFormat ALIAS

The signature of the user is "ALIAS"

SHORT

public static final UserNameFormat SHORT

The signature of the user is "FIRSTNAME LASTNAME". If firstname and lastname are not defined the string will look like "ALIAS".

MEDIUM

public static final UserNameFormat MEDIUM

The signature of the user is "FIRSTNAME LASTNAME (ALIAS)". If firstname and lastname are not defined the string will look like "ALIAS".

LONG

public static final UserNameFormat LONG

The signature of the user is "SALUTATIONS FIRSTNAME LASTNAME". If firstname and lastname are not defined the string will look like "ALIAS".

Method Detail

values

public static UserNameFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (UserNameFormat c : UserNameFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static UserNameFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null