com.filenet.wcm.toolkit.util
Class WcmString

java.lang.Object
  extended bycom.filenet.wcm.toolkit.util.WcmString

public class WcmString
extends java.lang.Object

WcmString is a utility class to retrieve a localized string from the resource file using the given key. This class is used by P8 (client-side applets).


Constructor Summary
WcmString(java.util.Locale locale, java.lang.String aKey, java.lang.String engString)
           
WcmString(java.util.Locale locale, java.lang.String aKey, java.lang.String engString, java.lang.Object arg0)
          Constructor that features the ability to supply the first argument to apply when formatting the resource string.
WcmString(java.util.Locale locale, java.lang.String aKey, java.lang.String engString, java.lang.Object[] arguments)
          Constructor that features the ability to supply any number of arguments to apply when formatting the resource string.
WcmString(java.util.Locale locale, java.lang.String aKey, java.lang.String engString, java.lang.Object arg0, java.lang.Object arg1)
          Constructor that features the ability to supply a first and second argument to apply when formatting the resource string.
WcmString(java.util.Locale locale, java.lang.String aKey, java.lang.String engString, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2)
          Constructor that features the ability to supply three arguments to apply when formatting the resource string.
WcmString(java.lang.String aKey, java.lang.String engString)
          Default Constructor
WcmString(java.lang.String aKey, java.lang.String engString, java.lang.Object arg0)
          Constructor that features the ability to supply the first argument to apply when formatting the resource string.
WcmString(java.lang.String aKey, java.lang.String engString, java.lang.Object[] arguments)
          Constructor that features the ability to supply any number of arguments to apply when formatting the resource string.
WcmString(java.lang.String aKey, java.lang.String engString, java.lang.Object arg0, java.lang.Object arg1)
          Constructor that features the ability to supply a first and second argument to apply when formatting the resource string.
WcmString(java.lang.String aKey, java.lang.String engString, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2)
          Constructor that features the ability to supply three arguments to apply when formatting the resource string.
 
Method Summary
static int compare(java.lang.String string1, java.lang.String string2)
          Locale sensitive string comparison - case sensitive.
static int compareIgnoreCase(java.lang.String string1, java.lang.String string2)
          Locale sensitive string comparison - case ignored.
 boolean equals(java.lang.Object anObject)
          Compares this WcmString object to the specified object.
static boolean equals(java.lang.String string1, java.lang.String string2)
          Locale sensitive string equality comparison - case sensitive.
 java.lang.String getKey()
          Returns WcmString key
static void loadResource(java.io.InputStream in)
          Deprecated. This method has been replaced. use WcmStringResources.addStringToBundlePath and/or WcmStringResources.addExcetpionToBundlePath.
static void loadResource(java.util.Map m)
          Deprecated. This method has been replaced. WcmStringResources.addStringToBundlePath and/or WcmStringResources.addExcetpionToBundlePath.
static java.lang.String localize(java.util.Locale locale, java.lang.String aKey, java.lang.String engString)
          Static method for retrieving the represented string from the resource file.
static java.lang.String localize(java.util.Locale locale, java.lang.String aKey, java.lang.String engString, java.lang.Object args0)
          Static method for retrieving the represented string from the resource file.
static java.lang.String localize(java.util.Locale locale, java.lang.String key, java.lang.String engString, java.lang.Object[] args)
          Static method for retrieving the represented string from the resource file.
static java.lang.String localize(java.util.Locale locale, java.lang.String aKey, java.lang.String engString, java.lang.Object args0, java.lang.Object args1)
          Static method for retrieving the represented string from the resource file.
static java.lang.String localize(java.util.Locale locale, java.lang.String aKey, java.lang.String engString, java.lang.Object args0, java.lang.Object args1, java.lang.Object args2)
          Static method for retrieving the represented string from the resource file.
static java.lang.String localize(java.lang.String aKey, java.lang.String engString)
          Static method for retrieving the represented string from the resource file.
static java.lang.String localize(java.lang.String aKey, java.lang.String engString, java.lang.Object args0)
          Static method for retrieving the represented string from the resource file.
static java.lang.String localize(java.lang.String key, java.lang.String engString, java.lang.Object[] args)
          Static method for retrieving the represented string from the resource file.
static java.lang.String localize(java.lang.String aKey, java.lang.String engString, java.lang.Object args0, java.lang.Object args1)
          Static method for retrieving the represented string from the resource file.
static java.lang.String localize(java.lang.String aKey, java.lang.String engString, java.lang.Object args0, java.lang.Object args1, java.lang.Object args2)
          Static method for retrieving the represented string from the resource file.
 java.lang.String toString()
          Method for retrieving the represented string from the resource file.
 java.lang.String toString(java.util.Locale locale)
          Method for retrieving the represented string from the resource file.
 java.lang.String toString(java.util.Locale locale, java.lang.Object args0)
          Method for retrieving the represented string from the resource file.
 java.lang.String toString(java.util.Locale locale, java.lang.Object[] args)
          Method for retrieving the represented string from the resource file.
 java.lang.String toString(java.util.Locale locale, java.lang.Object args0, java.lang.Object args1)
          Method for retrieving the represented string from the resource file.
 java.lang.String toString(java.util.Locale locale, java.lang.Object args0, java.lang.Object args1, java.lang.Object args2)
          Method for retrieving the represented string from the resource file.
 java.lang.String toString(java.lang.Object args0)
          Method for retrieving the represented string from the resource file.
 java.lang.String toString(java.lang.Object[] args)
          Method for retrieving the represented string from the resource file.
 java.lang.String toString(java.lang.Object args0, java.lang.Object args1)
          Method for retrieving the represented string from the resource file.
 java.lang.String toString(java.lang.Object args0, java.lang.Object args1, java.lang.Object args2)
          Method for retrieving the represented string from the resource file.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WcmString

public WcmString(java.lang.String aKey,
                 java.lang.String engString)
Default Constructor

Parameters:
aKey - Key for looking up a resource in the resource file.
engString - English version of resource string which we use to generate the resource file with.

WcmString

public WcmString(java.lang.String aKey,
                 java.lang.String engString,
                 java.lang.Object arg0)
Constructor that features the ability to supply the first argument to apply when formatting the resource string.

Parameters:
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
arg0 - First argument to be applied when formatting the resource string.

WcmString

public WcmString(java.lang.String aKey,
                 java.lang.String engString,
                 java.lang.Object arg0,
                 java.lang.Object arg1)
Constructor that features the ability to supply a first and second argument to apply when formatting the resource string.

Parameters:
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
arg0 - First argument to be applied when formatting the resource string.
arg1 - Second argument to be applied when formatting the resource string.

WcmString

public WcmString(java.lang.String aKey,
                 java.lang.String engString,
                 java.lang.Object arg0,
                 java.lang.Object arg1,
                 java.lang.Object arg2)
Constructor that features the ability to supply three arguments to apply when formatting the resource string.

Parameters:
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
arg0 - First argument to be applied when formatting the resource string.
arg1 - Second argument to be applied when formatting the resource string.
arg2 - Third argument to be applied when formatting the resource string.

WcmString

public WcmString(java.lang.String aKey,
                 java.lang.String engString,
                 java.lang.Object[] arguments)
Constructor that features the ability to supply any number of arguments to apply when formatting the resource string.

Parameters:
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
arguments - Variable number of arguments for generating a string from a resource template string.

WcmString

public WcmString(java.util.Locale locale,
                 java.lang.String aKey,
                 java.lang.String engString)
Parameters:
aKey - Key for looking up a resource in the resource file.
engString - English version of resource string which we use to generate the resource file with.

WcmString

public WcmString(java.util.Locale locale,
                 java.lang.String aKey,
                 java.lang.String engString,
                 java.lang.Object arg0)
Constructor that features the ability to supply the first argument to apply when formatting the resource string.

Parameters:
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
arg0 - First argument to be applied when formatting the resource string.

WcmString

public WcmString(java.util.Locale locale,
                 java.lang.String aKey,
                 java.lang.String engString,
                 java.lang.Object arg0,
                 java.lang.Object arg1)
Constructor that features the ability to supply a first and second argument to apply when formatting the resource string.

Parameters:
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
arg0 - First argument to be applied when formatting the resource string.
arg1 - Second argument to be applied when formatting the resource string.

WcmString

public WcmString(java.util.Locale locale,
                 java.lang.String aKey,
                 java.lang.String engString,
                 java.lang.Object arg0,
                 java.lang.Object arg1,
                 java.lang.Object arg2)
Constructor that features the ability to supply three arguments to apply when formatting the resource string.

Parameters:
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
arg0 - First argument to be applied when formatting the resource string.
arg1 - Second argument to be applied when formatting the resource string.
arg2 - Third argument to be applied when formatting the resource string.

WcmString

public WcmString(java.util.Locale locale,
                 java.lang.String aKey,
                 java.lang.String engString,
                 java.lang.Object[] arguments)
Constructor that features the ability to supply any number of arguments to apply when formatting the resource string.

Parameters:
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
arguments - Variable number of arguments for generating a string from a resource template string.
Method Detail

toString

public java.lang.String toString()
Method for retrieving the represented string from the resource file.

Returns:
Resource string if available otherwise return the default value.

toString

public java.lang.String toString(java.util.Locale locale)
Method for retrieving the represented string from the resource file.

Returns:
Resource string if available otherwise return the default value.

localize

public static java.lang.String localize(java.lang.String aKey,
                                        java.lang.String engString)
Static method for retrieving the represented string from the resource file.

Parameters:
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
Returns:
Resource string if available otherwise return the default value.

localize

public static java.lang.String localize(java.util.Locale locale,
                                        java.lang.String aKey,
                                        java.lang.String engString)
Static method for retrieving the represented string from the resource file.

Parameters:
locale - Locale for mapping.
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
Returns:
Resource string if available otherwise return the default value.

toString

public java.lang.String toString(java.lang.Object args0)
Method for retrieving the represented string from the resource file.

Parameters:
args0 - First argument to be applied when formatting the resource string.
Returns:
Resource string if available otherwise return the default value.

toString

public java.lang.String toString(java.util.Locale locale,
                                 java.lang.Object args0)
Method for retrieving the represented string from the resource file.

Parameters:
args0 - First argument to be applied when formatting the resource string.
Returns:
Resource string if available otherwise return the default value.

localize

public static java.lang.String localize(java.lang.String aKey,
                                        java.lang.String engString,
                                        java.lang.Object args0)
Static method for retrieving the represented string from the resource file.

Parameters:
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
args0 - First argument to be applied when formatting the resource string.
Returns:
Resource string if available otherwise return the default value.

localize

public static java.lang.String localize(java.util.Locale locale,
                                        java.lang.String aKey,
                                        java.lang.String engString,
                                        java.lang.Object args0)
Static method for retrieving the represented string from the resource file.

Parameters:
locale - Locale for mapping.
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
args0 - First argument to be applied when formatting the resource string.
Returns:
Resource string if available otherwise return the default value.

toString

public java.lang.String toString(java.lang.Object args0,
                                 java.lang.Object args1)
Method for retrieving the represented string from the resource file.

Parameters:
args0 - First argument to be applied when formatting the resource string.
args1 - Second argument to be applied when formatting the resource string.
Returns:
Resource string if available otherwise return the default value.

toString

public java.lang.String toString(java.util.Locale locale,
                                 java.lang.Object args0,
                                 java.lang.Object args1)
Method for retrieving the represented string from the resource file.

Parameters:
args0 - First argument to be applied when formatting the resource string.
args1 - Second argument to be applied when formatting the resource string.
Returns:
Resource string if available otherwise return the default value.

localize

public static java.lang.String localize(java.lang.String aKey,
                                        java.lang.String engString,
                                        java.lang.Object args0,
                                        java.lang.Object args1)
Static method for retrieving the represented string from the resource file.

Parameters:
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
args0 - First argument to be applied when formatting the resource string.
args1 - Second argument to be applied when formatting the resource string.
Returns:
Resource string if available otherwise return the default value.

localize

public static java.lang.String localize(java.util.Locale locale,
                                        java.lang.String aKey,
                                        java.lang.String engString,
                                        java.lang.Object args0,
                                        java.lang.Object args1)
Static method for retrieving the represented string from the resource file.

Parameters:
locale - Locale for mapping.
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
args0 - First argument to be applied when formatting the resource string.
args1 - Second argument to be applied when formatting the resource string.
Returns:
Resource string if available otherwise return the default value.

toString

public java.lang.String toString(java.lang.Object args0,
                                 java.lang.Object args1,
                                 java.lang.Object args2)
Method for retrieving the represented string from the resource file.

Parameters:
args0 - First argument to be applied when formatting the resource string.
args1 - Second argument to be applied when formatting the resource string.
args2 - Third argument to be applied when formatting the resource string.
Returns:
Resource string if available otherwise return the default value.

toString

public java.lang.String toString(java.util.Locale locale,
                                 java.lang.Object args0,
                                 java.lang.Object args1,
                                 java.lang.Object args2)
Method for retrieving the represented string from the resource file.

Parameters:
args0 - First argument to be applied when formatting the resource string.
args1 - Second argument to be applied when formatting the resource string.
args2 - Third argument to be applied when formatting the resource string.
Returns:
Resource string if available otherwise return the default value.

localize

public static java.lang.String localize(java.lang.String aKey,
                                        java.lang.String engString,
                                        java.lang.Object args0,
                                        java.lang.Object args1,
                                        java.lang.Object args2)
Static method for retrieving the represented string from the resource file.

Parameters:
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
args0 - First argument to be applied when formatting the resource string.
args1 - Second argument to be applied when formatting the resource string.
args2 - Third argument to be applied when formatting the resource string.
Returns:
Resource string if available otherwise return the default value.

localize

public static java.lang.String localize(java.util.Locale locale,
                                        java.lang.String aKey,
                                        java.lang.String engString,
                                        java.lang.Object args0,
                                        java.lang.Object args1,
                                        java.lang.Object args2)
Static method for retrieving the represented string from the resource file.

Parameters:
locale - Locale for mapping.
aKey - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
args0 - First argument to be applied when formatting the resource string.
args1 - Second argument to be applied when formatting the resource string.
args2 - Third argument to be applied when formatting the resource string.
Returns:
Resource string if available otherwise return the default value.

toString

public java.lang.String toString(java.lang.Object[] args)
Method for retrieving the represented string from the resource file.

Parameters:
args - Variable number of arguments for generating a string from a resource template string.
Returns:
Resource string if available otherwise return the default value.

toString

public java.lang.String toString(java.util.Locale locale,
                                 java.lang.Object[] args)
Method for retrieving the represented string from the resource file.

Parameters:
locale - Locale for mapping.
args - Variable number of arguments for generating a string from a resource template string.
Returns:
Resource string if available otherwise return the default value.

localize

public static java.lang.String localize(java.lang.String key,
                                        java.lang.String engString,
                                        java.lang.Object[] args)
Static method for retrieving the represented string from the resource file.

Parameters:
key - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
args - Variable number of arguments for generating a string from a resource template string.
Returns:
Resource string if available otherwise return the default value.

localize

public static java.lang.String localize(java.util.Locale locale,
                                        java.lang.String key,
                                        java.lang.String engString,
                                        java.lang.Object[] args)
Static method for retrieving the represented string from the resource file.

Parameters:
locale - Locale for mapping.
key - Key for looking up the specified resource string.
engString - English version of resource string which we use to generate the resource file with.
args - Variable number of arguments for generating a string from a resource template string.
Returns:
Resource string if available otherwise return the default value.

compare

public static int compare(java.lang.String string1,
                          java.lang.String string2)
Locale sensitive string comparison - case sensitive.

Parameters:
string1 - First string for the comparison
string2 - Second string for the comparison
Returns:
If the strings are identical, return 0; If the first string is larger than the second one, return > 0; otherwise, return < 0

equals

public static boolean equals(java.lang.String string1,
                             java.lang.String string2)
Locale sensitive string equality comparison - case sensitive.

Parameters:
string1 - First string for the comparison
string2 - Second string for the comparison
Returns:
If the strings are identical, return true; otherwise, return false

compareIgnoreCase

public static int compareIgnoreCase(java.lang.String string1,
                                    java.lang.String string2)
Locale sensitive string comparison - case ignored.

Parameters:
string1 - First string for the comparison
string2 - Second string for the comparison
Returns:
If the strings are identical, return 0; If the first string is larger than the second one, return > 0; otherwise, return < 0

equals

public boolean equals(java.lang.Object anObject)
Compares this WcmString object to the specified object. The result is true if and only if the argument is not null and is a WcmString object that represents the same sequence of characters as this object

Parameters:
anObject - - the object to compare this WcmString against.
Returns:
true if the String are equal; false otherwise.

getKey

public java.lang.String getKey()
Returns WcmString key

Returns:
key

loadResource

public static void loadResource(java.io.InputStream in)
                         throws java.io.IOException
Deprecated. This method has been replaced. use WcmStringResources.addStringToBundlePath and/or WcmStringResources.addExcetpionToBundlePath.

Loads a new globalization resource bundle

Parameters:
in - InputStream object
Throws:
java.io.IOException - if any IO Errors occur

loadResource

public static void loadResource(java.util.Map m)
Deprecated. This method has been replaced. WcmStringResources.addStringToBundlePath and/or WcmStringResources.addExcetpionToBundlePath.

Loads a new globalization resource bundle

Parameters:
m - Map object containing key-value pairs


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.