com.communote.server.core.user.helper

Class UserNameHelper

java.lang.Object

com.communote.server.core.user.helper.UserNameHelper

public final class UserNameHelper
extends Object

Helper class to get a user to string for frontend or mails

Author:

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

Method Summary

Modifier and Type	Method and Description
static String	getCompleteSignature(String salutation, String firstName, String lastName, String separator, String fallback) Get the compelte signature
static String	getCompleteSignature(User user) Get the complete signature of the user which is "'SALUATAION' 'FIRSTNAME' 'LASTNAME'".
static String	getCompleteSignature(UserName profile, String separator, String fallback) Get the complete signature of the profile which is "'SALUATAION' 'FIRSTNAME' 'LASTNAME'".
static String	getCompleteSignature(UserName profile, String separator, String fallback, boolean includeSalutation) Get the complete signature of the profile which is "'SALUATAION' 'FIRSTNAME' 'LASTNAME'".
static String	getCompleteSignature(User user, String separator, String fallback) Get the complete signature of the user which is "'SALUATAION' 'FIRSTNAME' 'LASTNAME'".
static String	getDefaultUserSignature(User user) Get the default username of the user which is "'SALUATAION' 'FIRSTNAME' 'LASTNAME'".
static String	getDefaultUserSignature(UserData userListItem) Get the complete signature of the user which is "'SALUATAION' 'FIRSTNAME' 'LASTNAME'".
static String	getDetailedUserSignature(String firstName, String lastName, String alias) Returns the string containing "'FIRSTNAME' 'LASTNAME' ('ALIAS')".
static String	getDetailedUserSignature(User user)
static String	getDetailedUserSignature(UserData userListItem) Returns the string containing "'FIRSTNAME' 'LASTNAME' ('ALIAS')".
static String	getSimpleDefaultUserSignature(NoteData noteListData) Returns a simple user signature consisting of "'FIRSTNAME' 'LASTNAME'" or "'ALIAS'" in case firstname and lastname are not defined.
static String	getSimpleDefaultUserSignature(String firstName, String lastName, String alias) Returns a simple user signature consisting of "'FIRSTNAME' 'LASTNAME'" or "'ALIAS'" in case firstname and lastname are not defined.
static String	getSimpleDefaultUserSignature(User user) Returns a simple user signature consisting of "'FIRSTNAME' 'LASTNAME'" or "'ALIAS'" in case firstname and lastname are not defined.
static String	getSimpleDefaultUserSignature(UserData userListItem) Returns a simple user signature consisting of "'FIRSTNAME' 'LASTNAME'" or "'ALIAS'" in case firstname and lastname are not defined.
static String	getSimpleDefaultUserSignature(UserProfileDetails profileDetails) Returns a simple user signature consisting of "'FIRSTNAME' 'LASTNAME'" or "'ALIAS'" in case firstname and lastname are not defined.
static String	getUserSignature(UserData userListItem, UserNameFormat format) To get the signature of an user.
static String	getUserSignature(UserProfileDetailListItem listItem, UserNameFormat format) To get the signature of an user.
static String	getUserSignature(User user, UserNameFormat format) To get the signature of an user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCompleteSignature

public static String getCompleteSignature(User user)

Get the complete signature of the user which is "'SALUATAION' 'FIRSTNAME' 'LASTNAME'". If the profile is not yet set, the e-mail address will be returned.

Parameters:

user - the user to use

Returns:

the salutation or null

getCompleteSignature

public static String getCompleteSignature(User user,
                                          String separator,
                                          String fallback)

Get the complete signature of the user which is "'SALUATAION' 'FIRSTNAME' 'LASTNAME'". If the profile is not yet set, fallback will be returned.

Parameters:

user - the user to use

separator - the separator to use between the elements

fallback - the fallback in case the profile is not available

Returns:

the salutation or the fallback

getCompleteSignature

public static String getCompleteSignature(String salutation,
                                          String firstName,
                                          String lastName,
                                          String separator,
                                          String fallback)

Get the compelte signature

Parameters:

salutation - the salutation

firstName - first name

lastName - last name

separator - the separator to use

fallback - a fallback if all is blank

Returns:

the signature

getCompleteSignature

public static String getCompleteSignature(UserName profile,
                                          String separator,
                                          String fallback)

Get the complete signature of the profile which is "'SALUATAION' 'FIRSTNAME' 'LASTNAME'". If the profile is not yet set, fallback will be returned.

Parameters:

profile - the profile to use

separator - the separator to use between the elements

fallback - the fallback in case the profile is not available

Returns:

the salutation or the fallback

getCompleteSignature

public static String getCompleteSignature(UserName profile,
                                          String separator,
                                          String fallback,
                                          boolean includeSalutation)

Get the complete signature of the profile which is "'SALUATAION' 'FIRSTNAME' 'LASTNAME'". If the profile is not yet set, fallback will be returned.

Parameters:

profile - the profile to use

separator - the separator to use between the elements

fallback - the fallback in case the profile is not available

includeSalutation - whether to include the salutation into the returned signature

Returns:

the signature or the fallback

getDefaultUserSignature

public static String getDefaultUserSignature(User user)

Get the default username of the user which is "'SALUATAION' 'FIRSTNAME' 'LASTNAME'". If the profile is not yet set, null will be returned.

Parameters:

user - the user to use

Returns:

the salutation or null

getDefaultUserSignature

public static String getDefaultUserSignature(UserData userListItem)

Get the complete signature of the user which is "'SALUATAION' 'FIRSTNAME' 'LASTNAME'". If the profile is not yet set, null will be returned.

Parameters:

userListItem - the user list item to use

Returns:

the salutation or null

getDetailedUserSignature

public static String getDetailedUserSignature(User user)

Parameters:

user - the user to use

Returns:

a detailed signature

getDetailedUserSignature

public static String getDetailedUserSignature(String firstName,
                                              String lastName,
                                              String alias)

Returns the string containing "'FIRSTNAME' 'LASTNAME' ('ALIAS')". If firstname and lastname are not defined the string will look like "'ALIAS'".

Parameters:

firstName - the firstname

lastName - the lastname

alias - the alias

Returns:

the user string

getDetailedUserSignature

public static String getDetailedUserSignature(UserData userListItem)

Returns the string containing "'FIRSTNAME' 'LASTNAME' ('ALIAS')". If firstname and lastname are not defined the string will look like "'ALIAS'".

Parameters:

userListItem - the userListItem to use

Returns:

the user string

getSimpleDefaultUserSignature

public static String getSimpleDefaultUserSignature(User user)

Returns a simple user signature consisting of "'FIRSTNAME' 'LASTNAME'" or "'ALIAS'" in case firstname and lastname are not defined.

Parameters:

user - the user to use

Returns:

the signature

getSimpleDefaultUserSignature

public static String getSimpleDefaultUserSignature(UserProfileDetails profileDetails)

Returns a simple user signature consisting of "'FIRSTNAME' 'LASTNAME'" or "'ALIAS'" in case firstname and lastname are not defined.

Parameters:

profileDetails - object holding the user details

Returns:

the signature

getSimpleDefaultUserSignature

public static String getSimpleDefaultUserSignature(NoteData noteListData)

Returns a simple user signature consisting of "'FIRSTNAME' 'LASTNAME'" or "'ALIAS'" in case firstname and lastname are not defined.

Parameters:

noteListData - the user list item to use

Returns:

the signature

getSimpleDefaultUserSignature

public static String getSimpleDefaultUserSignature(String firstName,
                                                   String lastName,
                                                   String alias)

Returns a simple user signature consisting of "'FIRSTNAME' 'LASTNAME'" or "'ALIAS'" in case firstname and lastname are not defined.

Parameters:

firstName - the first name of the user

lastName - the last name

alias - the alias

Returns:

the signature

getSimpleDefaultUserSignature

public static String getSimpleDefaultUserSignature(UserData userListItem)

Returns a simple user signature consisting of "'FIRSTNAME' 'LASTNAME'" or "'ALIAS'" in case firstname and lastname are not defined.

Parameters:

userListItem - the user list item to use

Returns:

the signature

getUserSignature

public static String getUserSignature(User user,
                                      UserNameFormat format)

To get the signature of an user.

Parameters:

user - the user to use

format - the format of the user signature

Returns:

the user signature

getUserSignature

public static String getUserSignature(UserData userListItem,
                                      UserNameFormat format)

To get the signature of an user.

Parameters:

userListItem - the user list item to use

format - the format of the user signature

Returns:

the user signature

getUserSignature

public static String getUserSignature(UserProfileDetailListItem listItem,
                                      UserNameFormat format)

To get the signature of an user.

Parameters:

listItem - the list item to use

format - the format of the user signature

Returns:

the user signature