com.filenet.wcm.toolkit.util

Class WcmString

  1. java.lang.Object
  2. extended bycom.filenet.wcm.toolkit.util.WcmString
  1. public class WcmString
  2. 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

Constructor and Description
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

Modifier and Type Method and Description
  1. static
  2. int
 compare(java.lang.String string1,java.lang.String string2)
Locale sensitive string comparison - case sensitive.
  1. static
  2. int
 compareIgnoreCase(java.lang.String string1,java.lang.String string2)
Locale sensitive string comparison - case ignored.
  1. boolean
 equals(java.lang.Object anObject)
Compares this WcmString object to the specified object.
  1. static
  2. boolean
 equals(java.lang.String string1,java.lang.String string2)
Locale sensitive string equality comparison - case sensitive.
  1. java.lang.String
 getKey()
Returns WcmString key
  1. static
  2. void
 loadResource(java.io.InputStream in)
Deprecated. This method has been replaced. use WcmStringResources.addStringToBundlePath and/or WcmStringResources.addExcetpionToBundlePath.
  1. static
  2. void
 loadResource(java.util.Map m)
Deprecated. This method has been replaced. WcmStringResources.addStringToBundlePath and/or WcmStringResources.addExcetpionToBundlePath.
  1. static
  2. 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.
  1. static
  2. 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.
  1. static
  2. 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.
  1. static
  2. 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.
  1. static
  2. 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.
  1. static
  2. java.lang.String
 localize(java.lang.String aKey,java.lang.String engString)
Static method for retrieving the represented string from the resource file.
  1. static
  2. 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.
  1. static
  2. 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.
  1. static
  2. 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.
  1. static
  2. 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.
  1. java.lang.String
 toString()
Method for retrieving the represented string from the resource file.
  1. java.lang.String
 toString(java.util.Locale locale)
Method for retrieving the represented string from the resource file.
  1. java.lang.String
 toString(java.util.Locale locale,java.lang.Object args0)
Method for retrieving the represented string from the resource file.
  1. java.lang.String
 toString(java.util.Locale locale,java.lang.Object[] args)
Method for retrieving the represented string from the resource file.
  1. 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.
  1. 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.
  1. java.lang.String
 toString(java.lang.Object args0)
Method for retrieving the represented string from the resource file.
  1. java.lang.String
 toString(java.lang.Object[] args)
Method for retrieving the represented string from the resource file.
  1. java.lang.String
 toString(java.lang.Object args0,java.lang.Object args1)
Method for retrieving the represented string from the resource file.
  1. 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

  1. public WcmString(java.lang.String aKey,
  2. 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

  1. public WcmString(java.lang.String aKey,
  2. java.lang.String engString,
  3. 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

  1. public WcmString(java.lang.String aKey,
  2. java.lang.String engString,
  3. java.lang.Object arg0,
  4. 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

  1. public WcmString(java.lang.String aKey,
  2. java.lang.String engString,
  3. java.lang.Object arg0,
  4. java.lang.Object arg1,
  5. 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

  1. public WcmString(java.lang.String aKey,
  2. java.lang.String engString,
  3. 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

  1. public WcmString(java.util.Locale locale,
  2. java.lang.String aKey,
  3. 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

  1. public WcmString(java.util.Locale locale,
  2. java.lang.String aKey,
  3. java.lang.String engString,
  4. 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

  1. public WcmString(java.util.Locale locale,
  2. java.lang.String aKey,
  3. java.lang.String engString,
  4. java.lang.Object arg0,
  5. 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

  1. public WcmString(java.util.Locale locale,
  2. java.lang.String aKey,
  3. java.lang.String engString,
  4. java.lang.Object arg0,
  5. java.lang.Object arg1,
  6. 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

  1. public WcmString(java.util.Locale locale,
  2. java.lang.String aKey,
  3. java.lang.String engString,
  4. 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

  1. public java.lang.String toString( )
Method for retrieving the represented string from the resource file.
Overrides:
toString in class java.lang.Object
Returns:
Resource string if available otherwise return the default value.

toString

  1. 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

  1. public static java.lang.String localize( java.lang.String aKey,
  2. 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

  1. public static java.lang.String localize( java.util.Locale locale,
  2. java.lang.String aKey,
  3. 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

  1. 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

  1. public java.lang.String toString( java.util.Locale locale,
  2. 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

  1. public static java.lang.String localize( java.lang.String aKey,
  2. java.lang.String engString,
  3. 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

  1. public static java.lang.String localize( java.util.Locale locale,
  2. java.lang.String aKey,
  3. java.lang.String engString,
  4. 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

  1. public java.lang.String toString( java.lang.Object args0,
  2. 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

  1. public java.lang.String toString( java.util.Locale locale,
  2. java.lang.Object args0,
  3. 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

  1. public static java.lang.String localize( java.lang.String aKey,
  2. java.lang.String engString,
  3. java.lang.Object args0,
  4. 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

  1. public static java.lang.String localize( java.util.Locale locale,
  2. java.lang.String aKey,
  3. java.lang.String engString,
  4. java.lang.Object args0,
  5. 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

  1. public java.lang.String toString( java.lang.Object args0,
  2. java.lang.Object args1,
  3. 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

  1. public java.lang.String toString( java.util.Locale locale,
  2. java.lang.Object args0,
  3. java.lang.Object args1,
  4. 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

  1. public static java.lang.String localize( java.lang.String aKey,
  2. java.lang.String engString,
  3. java.lang.Object args0,
  4. java.lang.Object args1,
  5. 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

  1. public static java.lang.String localize( java.util.Locale locale,
  2. java.lang.String aKey,
  3. java.lang.String engString,
  4. java.lang.Object args0,
  5. java.lang.Object args1,
  6. 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

  1. 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

  1. public java.lang.String toString( java.util.Locale locale,
  2. 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

  1. public static java.lang.String localize( java.lang.String key,
  2. java.lang.String engString,
  3. 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

  1. public static java.lang.String localize( java.util.Locale locale,
  2. java.lang.String key,
  3. java.lang.String engString,
  4. 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

  1. public static int compare(java.lang.String string1,
  2. 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

  1. public static boolean equals(java.lang.String string1,
  2. 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

  1. public static int compareIgnoreCase( java.lang.String string1,
  2. 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

  1. 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
Overrides:
equals in class java.lang.Object
Parameters:
anObject - - the object to compare this WcmString against.
Returns:
true if the String are equal; false otherwise.

getKey

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

loadResource

  1. public static void loadResource( java.io.InputStream in)
  2. 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

  1. 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