Promoting the AFP renderer from sandbox to the main source tree.

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@425037 13f79535-47bb-0310-9956-ffa450edef68

3 files changed, 199 insertions, 0 deletions

diff --git a/src/java/org/apache/fop/render/afp/exceptions/FontRuntimeException.java b/src/java/org/apache/fop/render/afp/exceptions/FontRuntimeException.java
new file mode 100644
index 000000000..ea692b1dd
--- /dev/null
+++ b/src/java/org/apache/fop/render/afp/exceptions/FontRuntimeException.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2006 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.render.afp.exceptions;
+
+/**
+ * A runtime exception for handling fatal errors in processing fonts.
+ * <p/>
+ */
+public class FontRuntimeException extends NestedRuntimeException {
+
+    /**
+     * Constructs a FontRuntimeException with the specified message.
+     * @param msg the exception mesaage
+     */
+    public FontRuntimeException(String msg) {
+        super(msg);
+    }
+
+    /**
+     * Constructs a FontRuntimeException with the specified message
+     * wrapping the underlying exception.
+     * @param msg the exception mesaage
+     * @param t the underlying exception
+     */
+    public FontRuntimeException(String msg, Throwable t) {
+        super(msg, t);
+    }
+
+}
diff --git a/src/java/org/apache/fop/render/afp/exceptions/NestedRuntimeException.java b/src/java/org/apache/fop/render/afp/exceptions/NestedRuntimeException.java
new file mode 100644
index 000000000..3e8c1d947
--- /dev/null
+++ b/src/java/org/apache/fop/render/afp/exceptions/NestedRuntimeException.java
@@ -0,0 +1,109 @@
+/*
+ * Copyright 2006 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.render.afp.exceptions;
+
+import java.io.PrintStream;
+import java.io.PrintWriter;
+
+/**
+ * Handy class for wrapping runtime Exceptions with a root cause.
+ * This technique is no longer necessary in Java 1.4, which provides
+ * built-in support for exception nesting. Thus exceptions in applications
+ * written to use Java 1.4 need not extend this class.
+ *
+ */
+public abstract class NestedRuntimeException extends RuntimeException {
+    
+    /** Root cause of this nested exception */
+    private Throwable _underlyingException;
+    
+    /**
+     * Construct a <code>NestedRuntimeException</code> with the specified detail message.
+     * @param msg The detail message.
+     */
+    public NestedRuntimeException(String msg) {
+        super(msg);
+    }
+    
+    /**
+     * Construct a <code>NestedRuntimeException</code> with the specified
+     * detail message and nested exception.
+     * @param msg The detail message.
+     * @param t The nested exception.
+     */
+    public NestedRuntimeException(String msg, Throwable t) {
+        super(msg);
+        _underlyingException = t;
+        
+    }
+    
+    /**
+     * Gets the original triggering exception
+     * @return The original exception as a throwable.
+     */
+    public Throwable getUnderlyingException() {
+        
+        return _underlyingException;
+        
+    }
+    
+    /**
+     * Return the detail message, including the message from the nested
+     * exception if there is one.
+     * @return The detail message.
+     */
+    public String getMessage() {
+        
+        if (_underlyingException == null) {
+            return super.getMessage();
+        } else {
+            return super.getMessage()
+            + "; nested exception is "
+                + _underlyingException.getClass().getName();
+        }
+        
+    }
+    
+    /**
+     * Print the composite message and the embedded stack trace to the specified stream.
+     * @param ps the print stream
+     */
+    public void printStackTrace(PrintStream ps) {
+        if (_underlyingException == null) {
+            super.printStackTrace(ps);
+        } else {
+            ps.println(this);
+            _underlyingException.printStackTrace(ps);
+        }
+    }
+    
+    /**
+     * Print the composite message and the embedded stack trace to the specified writer.
+     * @param pw the print writer
+     */
+    public void printStackTrace(PrintWriter pw) {
+        if (_underlyingException == null) {
+            super.printStackTrace(pw);
+        } else {
+            pw.println(this);
+            _underlyingException.printStackTrace(pw);
+        }
+    }
+    
+}
diff --git a/src/java/org/apache/fop/render/afp/exceptions/RendererRuntimeException.java b/src/java/org/apache/fop/render/afp/exceptions/RendererRuntimeException.java
new file mode 100644
index 000000000..d04247196
--- /dev/null
+++ b/src/java/org/apache/fop/render/afp/exceptions/RendererRuntimeException.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2006 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.render.afp.exceptions;
+
+/**
+ * A runtime exception for handling fatal errors in rendering.
+ * <p/>
+ */
+public class RendererRuntimeException extends NestedRuntimeException {
+    
+    /**
+     * Constructs a RendererRuntimeException with the specified message.
+     * @param msg the exception mesaage
+     */
+    public RendererRuntimeException(String msg) {
+        super(msg);
+    }
+    
+    /**
+     * Constructs a RendererRuntimeException with the specified message
+     * wrapping the underlying exception.
+     * @param msg the exception mesaage
+     * @param t the underlying exception
+     */
+    public RendererRuntimeException(String msg, Throwable t) {
+        super(msg, t);
+    }
+    
+}