org.apache.fop.apps

Class FOPException

Known Direct Subclasses:
PropertyException, ValidationException

public class FOPException
extends SAXException

Exception thrown when FOP has a problem.

Constructor Summary

FOPException(Exception cause)
Constructs a new FOP exception with the specified cause.
FOPException(String message)
Constructs a new FOP exception with the specified detail message.
FOPException(String message, Exception cause)
Constructs a new exception with the specified detail message and cause.
FOPException(String message, Locator locator)
Constructs a new FOP exception with the specified detail message and location.
FOPException(String message, String systemId, int line, int column)
Constructs a new FOP exception with the specified detail message and location.

Method Summary

String
getMessage()
Returns the detail message string of this FOP exception.
protected Throwable
getRootException()
Attempts to recast the exception as other Throwable types.
boolean
isLocationSet()
Indicate whether a location was set.
void
printStackTrace()
Prints this FOP exception and its backtrace to the standard error stream.
void
printStackTrace(java.io.PrintStream stream)
Prints this FOP exception and its backtrace to the specified print stream.
void
printStackTrace(java.io.PrintWriter writer)
Prints this FOP exception and its backtrace to the specified print writer.
void
setLocation(String systemId, int line, int column)
Set a location associated with the exception.
void
setLocator(Locator locator)
Set a location associated with the exception.

Constructor Details

FOPException

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

FOPException

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

FOPException

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

FOPException

public FOPException(String message,
                    Locator locator)
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(String message,
                    String systemId,
                    int line,
                    int column)
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.

Method Details

getMessage

public String getMessage()
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)
Returns:
the detail message string of this FOP exception

getRootException

protected Throwable getRootException()
Attempts to recast the exception as other Throwable types.
Returns:
the exception recast as another type if possible, otherwise null.

isLocationSet

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

printStackTrace

public void printStackTrace()
Prints this FOP exception and its backtrace to the standard error stream.

printStackTrace

public void printStackTrace(java.io.PrintStream stream)
Prints this FOP exception and its backtrace to the specified print stream.
Parameters:
stream - PrintStream to use for output

printStackTrace

public void printStackTrace(java.io.PrintWriter writer)
Prints this FOP exception and its backtrace to the specified print writer.
Parameters:
writer - PrintWriter to use for output

setLocation

public void setLocation(String systemId,
                        int line,
                        int column)
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 - clolumn number in the line which is associated with the exception.

setLocator

public void setLocator(Locator locator)
Set a location associated with the exception.
Parameters:
locator - the locator holding the location.

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.