Package org.apache.fop.apps

Class FOPException

  • All Implemented Interfaces:
    java.io.Serializable
    @Deprecated
public class FOPException
extends org.xml.sax.SAXException
    Deprecated.
    Please avoid using package provided OOTB and/or migrate code to provide for this package in the custom code
    Exception thrown when FOP has a problem.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      FOPException​(java.lang.Exception cause)
      Deprecated.
      Constructs a new FOP exception with the specified cause.
      FOPException​(java.lang.String message)
      Deprecated.
      Constructs a new FOP exception with the specified detail message.
      FOPException​(java.lang.String message, java.lang.Exception cause)
      Deprecated.
      Constructs a new exception with the specified detail message and cause.
      FOPException​(java.lang.String message, java.lang.String systemId, int line, int column)
      Deprecated.
      Constructs a new FOP exception with the specified detail message and location.
      FOPException​(java.lang.String message, org.xml.sax.Locator locator)
      Deprecated.
      Constructs a new FOP exception with the specified detail message and location.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getLocalizedMessage()
      Deprecated.
      java.lang.String getMessage()
      Deprecated.
      Returns the detail message string of this FOP exception.
      boolean isLocationSet()
      Deprecated.
      Indicate whether a location was set.
      void printStackTrace()
      Deprecated.
      Prints this FOP exception and its backtrace to the standard error stream.
      void printStackTrace​(java.io.PrintStream stream)
      Deprecated.
      Prints this FOP exception and its backtrace to the specified print stream.
      void printStackTrace​(java.io.PrintWriter writer)
      Deprecated.
      Prints this FOP exception and its backtrace to the specified print writer.
      void setLocalizedMessage​(java.lang.String msg)
      Deprecated.
      Sets the localized message for this exception.
      void setLocation​(java.lang.String systemId, int line, int column)
      Deprecated.
      Set a location associated with the exception.
      void setLocator​(org.xml.sax.Locator locator)
      Deprecated.
      Set a location associated with the exception.

      • Methods inherited from class org.xml.sax.SAXException

        getCause, getException, toString

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getStackTrace, getSuppressed, initCause, setStackTrace

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FOPException

        public FOPException​(java.lang.String message)
        Deprecated.
        Constructs a new FOP exception with the specified detail message.
        Parameters:
        message - the detail message.

      • FOPException

        public FOPException​(java.lang.String message,
                    java.lang.String systemId,
                    int line,
                    int column)
        Deprecated.
        Constructs a new FOP exception with the specified detail message and location.
        Parameters:
        message - the detail message
        systemId - the system id of the FO document which is associated with the exception may be null.
        line - line number in the FO document which is associated with the exception.
        column - clolumn number in the line which is associated with the exception.

      • FOPException

        public FOPException​(java.lang.String message,
                    org.xml.sax.Locator locator)
        Deprecated.
        Constructs a new FOP exception with the specified detail message and location.
        Parameters:
        message - the detail message.
        locator - the locator holding the location.

      • FOPException

        public FOPException​(java.lang.Exception cause)
        Deprecated.
        Constructs a new FOP exception with the specified cause.
        Parameters:
        cause - the cause.

      • FOPException

        public FOPException​(java.lang.String message,
                    java.lang.Exception cause)
        Deprecated.
        Constructs a new exception with the specified detail message and cause.
        Parameters:
        message - the detail message
        cause - the cause

    • Method Detail

      • setLocator

        public void setLocator​(org.xml.sax.Locator locator)
        Deprecated.
        Set a location associated with the exception.
        Parameters:
        locator - the locator holding the location.

      • setLocation

        public void setLocation​(java.lang.String systemId,
                        int line,
                        int column)
        Deprecated.
        Set a location associated with the exception.
        Parameters:
        systemId - the system id of the FO document which is associated with the exception; may be null.
        line - line number in the FO document which is associated with the exception.
        column - column number in the line which is associated with the exception.

      • isLocationSet

        public boolean isLocationSet()
        Deprecated.
        Indicate whether a location was set.
        Returns:
        whether a location was set

      • getMessage

        public java.lang.String getMessage()
        Deprecated.
        Returns the detail message string of this FOP exception. If a location was set, the message is prepended with it in the form 
          SystemId:LL:CC: &the message&
        (the format used by most GNU tools)
        Overrides:
        getMessage in class org.xml.sax.SAXException
        Returns:
        the detail message string of this FOP exception

      • printStackTrace

        public void printStackTrace()
        Deprecated.
        Prints this FOP exception and its backtrace to the standard error stream.
        Overrides:
        printStackTrace in class java.lang.Throwable

      • printStackTrace

        public void printStackTrace​(java.io.PrintStream stream)
        Deprecated.
        Prints this FOP exception and its backtrace to the specified print stream.
        Overrides:
        printStackTrace in class java.lang.Throwable
        Parameters:
        stream - PrintStream to use for output

      • printStackTrace

        public void printStackTrace​(java.io.PrintWriter writer)
        Deprecated.
        Prints this FOP exception and its backtrace to the specified print writer.
        Overrides:
        printStackTrace in class java.lang.Throwable
        Parameters:
        writer - PrintWriter to use for output

      • setLocalizedMessage

        public void setLocalizedMessage​(java.lang.String msg)
        Deprecated.
        Sets the localized message for this exception.
        Parameters:
        msg - the localized message

      • getLocalizedMessage

        public java.lang.String getLocalizedMessage()
        Deprecated.
        Overrides:
        getLocalizedMessage in class java.lang.Throwable