com.adobe.livecycle.generatepdf.client
Class FileFormatNotSupportedException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.adobe.idp.dsc.DSCException
              extended by com.adobe.livecycle.generatepdf.client.PDFGBaseException
                  extended by com.adobe.livecycle.generatepdf.client.FileFormatNotSupportedException
All Implemented Interfaces:
java.io.Serializable

public class FileFormatNotSupportedException
extends PDFGBaseException
implements java.io.Serializable

Represesnts an exception that is raised if a given file format is not supported. This type of exception would be thrown by one of the convertPDF() or createPDF() methods in cases in which there is an attempt to create a PDF from or to convert an existing PDF to a format that the service does not support.

See Also:
Serialized Form

Field Summary
 int errorCode
          The error code associated with the file format exception.
 
Constructor Summary
FileFormatNotSupportedException(int errorCode)
          For internal use only.
FileFormatNotSupportedException(int errorCode, java.lang.String param)
          For internal use only.
FileFormatNotSupportedException(int errorCode, java.lang.String param, java.lang.Throwable cause)
          For internal use only.
FileFormatNotSupportedException(int errorCode, java.lang.Throwable cause)
          For internal use only.
 
Method Summary
 int getErrorCode()
          Returns the error code associated with the exception.
 
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
 

Field Detail

errorCode

public final int errorCode
The error code associated with the file format exception.

Constructor Detail

FileFormatNotSupportedException

public FileFormatNotSupportedException(int errorCode)
For internal use only. Do not use.

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

Parameters:
errorCode - The error code.

FileFormatNotSupportedException

public FileFormatNotSupportedException(int errorCode,
                                       java.lang.String param)
For internal use only. Do not use.

A constructor used to create a file format 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.

FileFormatNotSupportedException

public FileFormatNotSupportedException(int errorCode,
                                       java.lang.String param,
                                       java.lang.Throwable cause)
For internal use only. Do not use.

A constructor used to create a file format 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.

FileFormatNotSupportedException

public FileFormatNotSupportedException(int errorCode,
                                       java.lang.Throwable cause)
For internal use only. Do not use.

A constructor used to create a file format 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.

Overrides:
getErrorCode in class PDFGBaseException
Returns:
The error code.