com.adobe.livecycle.generatepdf.client
Class InvalidParameterException

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.InvalidParameterException

All Implemented Interfaces:

java.io.Serializable

public class InvalidParameterException
extends PDFGBaseException
implements java.io.Serializable

Represents an exception that is thrown when a given parameter is not valid.

See Also:

Serialized Form

Field Summary

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

Constructor Summary

InvalidParameterException(int errorCode)
For internal use only.

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

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

InvalidParameterException(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

InvalidParameterException

public InvalidParameterException(int errorCode)

For internal use only. Do not use. A constructor used to create an invalid parameter exception based on an error code.

Parameters:

errorCode - The error code.

InvalidParameterException

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

For internal use only. Do not use. A constructor used to create an invalid parameter 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.

InvalidParameterException

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

For internal use only. Do not use. A constructor used to create an invalid parameter 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.

InvalidParameterException

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

For internal use only. Do not use. A constructor used to create an invalid parameter 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.