Process Class Relationships

filenet.vw.api
Class VWException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--filenet.vw.api.VWException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
VWServerException

public class VWException
extends java.lang.Exception
implements java.io.Serializable

This is the base class for all workflow exceptions. Use this class to access the resource strings an application uses to create the exceptions.

See Also:
Serialized Form

Field Summary
static java.util.Hashtable propBundleHashTable
           
static java.lang.Object synchObject
          PropertyResourceBundle for the VWStrings file.
 
Constructor Summary
VWException(java.lang.String aKey, java.lang.String dummy)
          Constructor
VWException(java.lang.String aKey, java.lang.String dummy, java.lang.Object arg0)
          Constructor
VWException(java.lang.String aKey, java.lang.String dummy, java.lang.Object[] arguments)
          Constructor
VWException(java.lang.String aKey, java.lang.String dummy, java.lang.Object arg0, java.lang.Object arg1)
          Constructor
VWException(java.lang.String aKey, java.lang.String dummy, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2)
          Constructor
VWException(java.lang.Throwable cause)
          Constructor
 
Method Summary
 java.lang.String getCauseClassName()
           
 java.lang.String getCauseDescription()
           
 java.lang.String getKey()
          Retrieves the key to an exception.
 java.lang.String getLocalizedMessage()
          Retrieves the localized version of an exception message.
 java.lang.String getMessage()
          Retrieves the associated string from the exceptions resource file.
static java.lang.String getStringFromKey(java.lang.String theKey)
          Retrieves the string in the exceptions resource file that corresponds to the exception key.
 void setCause(java.lang.Throwable t)
           
 java.lang.String toString()
          Retrieves the associated string from the exceptions resource file.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, printStackTrace, printStackTrace, printStackTrace
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

synchObject

public static java.lang.Object synchObject
PropertyResourceBundle for the VWStrings file.
See Also:
PropertyResourceBundle

propBundleHashTable

public static java.util.Hashtable propBundleHashTable
Constructor Detail

VWException

public VWException(java.lang.Throwable cause)
Constructor
Parameters:
causeException - wrap the exception..

VWException

public VWException(java.lang.String aKey,
                   java.lang.String dummy)
Constructor
Parameters:
aKey - Key to use in looking up a resource in the VWExceptions file; an identifier of the form "vw.<package>.<id>" (e.g., vw.server.exception1)
dummy - English version of resource string the application uses to generate the VWExceptions file

VWException

public VWException(java.lang.String aKey,
                   java.lang.String dummy,
                   java.lang.Object arg0)
Constructor
Parameters:
aKey - Key to use in looking up the specified resource string
dummy - English version of the resource string the application uses to generate the VWExceptions file
arg0 - First argument to apply when formatting the resource string
See Also:
String

VWException

public VWException(java.lang.String aKey,
                   java.lang.String dummy,
                   java.lang.Object arg0,
                   java.lang.Object arg1)
Constructor
Parameters:
aKey - Key to use in looking up the specified resource string
dummy - English version of resource string the application uses to generate the VWExceptions file
arg0 - First argument to apply when formatting the resource string
arg1 - Second argument to apply when formatting the resource string
See Also:
String

VWException

public VWException(java.lang.String aKey,
                   java.lang.String dummy,
                   java.lang.Object arg0,
                   java.lang.Object arg1,
                   java.lang.Object arg2)
Constructor
Parameters:
aKey - Key to use in looking up the specified resource string
dummy - English version of the resource string the application uses to generate the VWExceptions file
arg0 - First argument to apply when formatting the resource string
arg1 - Second argument to apply when formatting the resource string
arg2 - Third argument to apply when formatting the resource string
See Also:
String

VWException

public VWException(java.lang.String aKey,
                   java.lang.String dummy,
                   java.lang.Object[] arguments)
Constructor
Parameters:
aKey - Key to use in looking up the specified resource string
dummy - English version of the resource string the application uses to generate the VWExceptions file
args - Variable number of arguments to use in generating a string from a resource template string
See Also:
String
Method Detail

setCause

public void setCause(java.lang.Throwable t)

getCauseClassName

public java.lang.String getCauseClassName()

getCauseDescription

public java.lang.String getCauseDescription()

toString

public java.lang.String toString()
Retrieves the associated string from the exceptions resource file.
Overrides:
toString in class java.lang.Throwable
Returns:
A string representing the exception file's associated string, if the string is available; otherwise the method returns the default value for the exception key.
See Also:
getStringFromKey( String ), getKey()

getMessage

public java.lang.String getMessage()
Retrieves the associated string from the exceptions resource file.
Overrides:
getMessage in class java.lang.Throwable
Returns:
A string representing the exception file's associated string, if the string is available; otherwise the method returns the default value for the exception key.
See Also:
getStringFromKey( String )

getKey

public java.lang.String getKey()
Retrieves the key to an exception.
Returns:
The key to an exception.
See Also:
String

getStringFromKey

public static java.lang.String getStringFromKey(java.lang.String theKey)
Retrieves the string in the exceptions resource file that corresponds to the exception key.
Returns:
The string that corresponds to the resource key, as defined in the exceptions resource file.

getLocalizedMessage

public java.lang.String getLocalizedMessage()
Retrieves the localized version of an exception message.
Overrides:
getLocalizedMessage in class java.lang.Throwable
Returns:
The localized version of an exception message.
See Also:
String


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.