com4j

Class ComException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com4j.ComException

All Implemented Interfaces:

Serializable

public class ComException
extends RuntimeException

Signals a failure in the COM method invocation.

Calling a wrapped COM method throws this exception when the underlying COM method returns a failure HRESULT code.

Author:

Kohsuke Kawaguchi (kk@kohsuke.org)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ComException(ComException cause) Constructs a new ComException with the given ComExcepton as cause.
ComException(String msg, int hresult) Constructs a new ComException with the given values
ComException(String msg, int hresult, String fileName, int line) Constructs a new ComException with the given values
ComException(String msg, String fileName, int line) Constructs a new ComException with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDetailMessage() Returns the message of the superclass
ErrorInfo	getErrorInfo() Gets the ErrorInfo object associated with this error.
int	getHRESULT() Returns the HRESULT value of this error.
String	getMessage()
String	toString()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

ComException

public ComException(String msg,
            int hresult,
            String fileName,
            int line)

Constructs a new ComException with the given values

Parameters:

msg - the message text of the Exception

hresult - the HRESULT value of the COM error

fileName - the file name of the source where the error occurred

line - the line in the file where the error occurred

ComException

public ComException(String msg,
            String fileName,
            int line)

Constructs a new ComException with the given values.

Parameters:

msg - the message text of the Exception

fileName - the file name of the source where the error occurred

line - the line in the file where the error occurred

ComException

public ComException(String msg,
            int hresult)

Constructs a new ComException with the given values

Parameters:

msg - the message text of the Exception

hresult - the HRESULT value of the COM error

ComException

public ComException(ComException cause)

Constructs a new ComException with the given ComExcepton as cause.

Parameters:

cause - the line in the file where the error occurred

Method Detail

getErrorInfo

public ErrorInfo getErrorInfo()

Gets the ErrorInfo object associated with this error.

Some COM objects can report additional error information beyond simple HRESULT value. If an error came from such an COM object, this method returns a non-null value, and you can query the returned ErrorInfo object for more information about the error.

Returns:

null if this exception doesn't have such detailed information.

getHRESULT

public int getHRESULT()

Returns the HRESULT value of this error.

Returns:

the HRESULT value of this error

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getDetailMessage

public String getDetailMessage()

Returns the message of the superclass

Returns:

the message of the superclass

toString

public String toString()

Overrides:

toString in class Throwable