wt.util
Class WTRemoteException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byjava.io.IOException
              extended byjava.rmi.RemoteException
                  extended bywt.util.WTRemoteException
All Implemented Interfaces:
LocalizableMessage, Message, Serializable

public class WTRemoteException
extends RemoteException
implements LocalizableMessage

WTRemoteException extends the capability of the java.lang.RemoteException in that like the wt.util.WTException, it accommodates nested exceptions and localizable text messages.



Supported API: true
Extendable: false

See Also:
wt.fc.WTException, Serialized Form

Field Summary
private static String versionID
           
private  WTException wte
           
 
Fields inherited from class java.rmi.RemoteException
detail
 
Fields inherited from class java.lang.Throwable
 
Constructor Summary
WTRemoteException(String s)
          Constructs a Windchill exception with a non-localizable detailed message.
WTRemoteException(String rb, String key, Object[] params)
          Constructs a WTRemoteException with a localizable detailed message.
WTRemoteException(String rb, String key, Object[] params, Throwable t)
          Constructs a WTRemoteException with an embedded Throwable object and a localizable detailed message.
WTRemoteException(String s, Throwable t)
          Constructs a WTRemoteException with an embedded Throwable object and non-localizable detailed message.
 
Method Summary
 String getLocalizedMessage()
          Returns the localized message, including nested exception.
 String getLocalizedMessage(boolean nested)
          Returns the localized message, optionally including nested exception.
 String getLocalizedMessage(Locale locale)
          Returns the localized message, for the specified locale, including nested exception.
 String getLocalizedMessage(Locale locale, boolean nested)
          Returns the localized message, for the specified locale, optionally including nested exception.
 String getMessage()
          Returns the message.
 Throwable getNestedThrowable()
          Returns the embedded throwable object.
static RemoteException newRemoteException(String msg, Throwable t)
          Factory method typed as RemoteException to allow bytecode verification of classes that use this factory method to defer loading WTRemoteException until necessary.
 void printStackTrace()
          Prints this WTRemoteException and the stack trace of its most deeply nested embedded Throwable to the standard error stream.
 void printStackTrace(PrintStream s)
          Prints this WTRemoteException and the stack trace of its most deeply nested embedded Throwable to the specified print stream.
 void printStackTrace(PrintWriter s)
          Prints this WTRemoteException and the stack trace of its most deeply nested embedded Throwable to the specified print writer.
 String toString()
          Returns a description of this WTRemoteException.
 String toString(boolean nested)
          Returns a description of this WTException.
 
Methods inherited from class java.rmi.RemoteException
getCause
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getStackTrace, initCause, setStackTrace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

versionID

private static final String versionID
See Also:
Constant Field Values

wte

private WTException wte
Constructor Detail

WTRemoteException

public WTRemoteException(String s)
Constructs a Windchill exception with a non-localizable detailed message.

Supported API: true

Parameters:
s - the detailed message

WTRemoteException

public WTRemoteException(String rb,
                         String key,
                         Object[] params)
Constructs a WTRemoteException with a localizable detailed message.

Supported API: true

Parameters:
rb - the name of the base resource bundle subclass containing the localizable message.
key - the key associated with the localizable message
params - an optional set of objects to be formatted into the localizable message text.
See Also:
ResourceBundle, MessageFormat

WTRemoteException

public WTRemoteException(String rb,
                         String key,
                         Object[] params,
                         Throwable t)
Constructs a WTRemoteException with an embedded Throwable object and a localizable detailed message.

Supported API: true

Parameters:
t - the embedded Throwable. It may be null.
rb - the name of the base resource bundle subclass containing the localizable message.
key - the key associated with the localizable message
params - an optional set of objects to be formatted into the localizable message text.
See Also:
ResourceBundle, MessageFormat

WTRemoteException

public WTRemoteException(String s,
                         Throwable t)
Constructs a WTRemoteException with an embedded Throwable object and non-localizable detailed message.

Supported API: true

Parameters:
t - the embedded Throwable. It may be null.
s - the detailed message. It may be null.
Method Detail

getLocalizedMessage

public String getLocalizedMessage()
Returns the localized message, including nested exception.

Supported API: true


getLocalizedMessage

public String getLocalizedMessage(Locale locale)
Returns the localized message, for the specified locale, including nested exception.

Supported API: true

Specified by:
getLocalizedMessage in interface LocalizableMessage
Parameters:
locale -
Returns:
String

getLocalizedMessage

public String getLocalizedMessage(Locale locale,
                                  boolean nested)
Returns the localized message, for the specified locale, optionally including nested exception.

Supported API: true

Parameters:
nested - include nested exceptions in message

getLocalizedMessage

public String getLocalizedMessage(boolean nested)
Returns the localized message, optionally including nested exception.

Supported API: true

Parameters:
nested - include nested exceptions in message

getMessage

public String getMessage()
Returns the message.

Supported API: true


getNestedThrowable

public Throwable getNestedThrowable()
Returns the embedded throwable object.

Supported API: true


newRemoteException

public static RemoteException newRemoteException(String msg,
                                                 Throwable t)
Factory method typed as RemoteException to allow bytecode verification of classes that use this factory method to defer loading WTRemoteException until necessary.

Supported API: true


printStackTrace

public void printStackTrace()
Prints this WTRemoteException and the stack trace of its most deeply nested embedded Throwable to the standard error stream.

Supported API: true


printStackTrace

public void printStackTrace(PrintStream s)
Prints this WTRemoteException and the stack trace of its most deeply nested embedded Throwable to the specified print stream.

Supported API: true


printStackTrace

public void printStackTrace(PrintWriter s)
Prints this WTRemoteException and the stack trace of its most deeply nested embedded Throwable to the specified print writer.

Supported API: true


toString

public String toString()
Returns a description of this WTRemoteException. The description includes the descriptions of the nested throwable objects that are embedded within this WTRemoteException.

Supported API: true


toString

public String toString(boolean nested)
Returns a description of this WTException. The description optionally includes the descriptions of the nested throwable objects that are embedded within this WTException.

Supported API: true

Parameters:
nested - include nested exceptions in message