com.adobe.livecycle.generatepdf.client
Class ConversionException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.adobe.idp.dsc.DSCException
              com.adobe.livecycle.generatepdf.client.PDFGBaseException
                  com.adobe.livecycle.generatepdf.client.ConversionException

All Implemented Interfaces:

java.io.Serializable

public class ConversionException
extends PDFGBaseException
implements java.io.Serializable

Represents an exception that is thrown if a conversion failed because of an underlying exception.

See Also:

Serialized Form

Constructor Summary

ConversionException(int errorCode)
For internal use only.

ConversionException(int errorCode, java.lang.String param)
For internal use only.

ConversionException(int errorCode, java.lang.String[] param)

ConversionException(int errorCode, java.lang.String param, java.lang.Throwable cause)
For internal use only.

ConversionException(int errorCode, java.lang.Throwable cause)
For internal use only.

Method Summary

java.lang.String	getConversionLog() Retrieves the optional conversion log.
int	getErrorCode() Returns the error code associated with the exception.
void	setConversionLog(java.lang.String conversionLog) For internal use only.

Methods inherited from class com.adobe.livecycle.generatepdf.client.PDFGBaseException

printFallbackStackTrace, printFallbackStackTrace, setFallbackConversionException

Methods inherited from class com.adobe.idp.dsc.DSCException

getError, getMessage, getNestedThrowable, toString

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConversionException

public ConversionException(int errorCode)

For internal use only. Do not use.

A constructor used to create a conversion exception based on an error code.

Parameters:

errorCode - The error code.

ConversionException

public ConversionException(int errorCode,
                           java.lang.String param)

For internal use only. Do not use.

A constructor used to create a conversion exception based on an error code, using a message to be displayed.

Parameters:

errorCode - The error code.

param - A parameter to be inserted in the message that is picked up from a file for the corresponding error code.

ConversionException

public ConversionException(int errorCode,
                           java.lang.String[] param)

ConversionException

public ConversionException(int errorCode,
                           java.lang.String param,
                           java.lang.Throwable cause)

For internal use only. Do not use.

A constructor used to create a conversion exception based on an error code, using a message to be displayed as well as a stack trace based on the cause of the exception.

Parameters:

errorCode - The error code.

param - A parameter to be inserted in the message that is picked up from a file for the corresponding error code.

cause - The exception class used to generate the stack trace based on the cause of the exception.

ConversionException

public ConversionException(int errorCode,
                           java.lang.Throwable cause)

For internal use only. Do not use. A constructor used to create a conversion exception based on an error code, as well as a stack trace based on the cause of the exception.

Parameters:

errorCode - The error code.

cause - The exception class used to generate the stack trace based on the cause of the exception.

Method Detail

getErrorCode

public int getErrorCode()

Returns the error code associated with the exception. The error code uniquely identifies the cause of the conversion error.

Overrides:

getErrorCode in class PDFGBaseException

Returns:

The error code.

getConversionLog

public java.lang.String getConversionLog()

Retrieves the optional conversion log. The conversion log may be able to provide more information about the exact cause of the failure of the conversion. For example, if some fonts were required to be embedded in the PDF file but they were missing on the server, the conversion log would be able to indicate this.

Returns:

A String containing the optional conversion log.

setConversionLog

public void setConversionLog(java.lang.String conversionLog)

For internal use only. Do not use.

Sets the optional conversion log.

Parameters:

conversionLog - A String containing the optional conversion log.