com.jivesoftware.forum.util
Class ForumUtils

java.lang.Object
  com.jivesoftware.forum.util.ForumUtils

public class ForumUtils
extends java.lang.Object

Utility class for common code that is not skin specific but is unique to Jive Forums.

Method Summary

static java.lang.String	getI18nKeyName(PrivateMessageFolder folder) Returns the i18n key name for the given folder.
static java.lang.String	replaceTokens(java.lang.String string, ForumMessage message, java.lang.String queryString) Replaces tokens with the correct values.

Methods inherited from class java.lang.Object

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

Method Detail

replaceTokens

public static java.lang.String replaceTokens(java.lang.String string,
                                             ForumMessage message,
                                             java.lang.String queryString)

Replaces tokens with the correct values. This is typically used by classes who need to generate emails. (e.g., watches, support notifications, interceptors, etc.)

Parameters:

string - the email template to do token replacements on.

getI18nKeyName

public static java.lang.String getI18nKeyName(PrivateMessageFolder folder)

Returns the i18n key name for the given folder. This method exists to centralize the i18n key name for the built-in private message folders in the system: Inbox, Sent, Drafts and Trash.

This method will return null for user defined folders.

Parameters:

folder - the PrivateMessageFolder object to examine.

Returns:

the i18n key name for the display name of the folder or null if no name exists (ie, it is a user-defined folder).