From 815f51c5a817c798116178a9912ba8a131e949aa Mon Sep 17 00:00:00 2001 From: William Victor Mote Date: Sat, 5 Jul 2003 09:28:34 +0000 Subject: [PATCH] style changes only git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196611 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/fop/apps/Driver.java | 33 ++++++------- .../org/apache/fop/apps/FOPException.java | 49 ++++++++++++++----- 2 files changed, 53 insertions(+), 29 deletions(-) diff --git a/src/java/org/apache/fop/apps/Driver.java b/src/java/org/apache/fop/apps/Driver.java index ea1b3d425..86c6d2206 100644 --- a/src/java/org/apache/fop/apps/Driver.java +++ b/src/java/org/apache/fop/apps/Driver.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,12 +42,12 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.apps; // FOP @@ -79,10 +79,8 @@ import javax.xml.parsers.ParserConfigurationException; import javax.xml.parsers.SAXParserFactory; // Java -import java.io.BufferedReader; import java.io.IOException; import java.io.OutputStream; -import java.util.Map; /** * Primary class that drives overall FOP process. @@ -292,8 +290,8 @@ public class Driver implements LogEnabled { } /** - * Provide the Driver instance with a logger. More information on Avalon - * logging can be found at the + * Provide the Driver instance with a logger. More information on Avalon + * logging can be found at the * Avalon site. * * @param log the logger. Must not be null. @@ -308,7 +306,7 @@ public class Driver implements LogEnabled { } /** - * Provide the Driver instance with a logger. + * Provide the Driver instance with a logger. * @param log the logger. Must not be null. * @deprecated Use #enableLogging(Logger) instead. */ @@ -458,7 +456,7 @@ public class Driver implements LogEnabled { * @param rendererClassName the fully qualified classname of the renderer * class to use. * @param version version number - * @deprecated use renderer.setProducer(version) + setRenderer(renderer) or + * @deprecated use renderer.setProducer(version) + setRenderer(renderer) or * just setRenderer(rendererType) which will use the default producer string. * @see #setRenderer(int) * @see #setRenderer(Renderer) @@ -513,7 +511,6 @@ public class Driver implements LogEnabled { /** * Add the element mapping with the given class name. * @param mappingClassName the class name representing the element mapping. - * @throws IllegalArgumentException if there was not such element mapping. */ public void addElementMapping(String mappingClassName) { treeBuilder.addElementMapping(mappingClassName); @@ -532,7 +529,7 @@ public class Driver implements LogEnabled { initialize(); } validateOutputStream(); - + // TODO: - do this stuff in a better way // PIJ: I guess the structure handler should be created by the renderer. if (rendererType == RENDER_MIF) { diff --git a/src/java/org/apache/fop/apps/FOPException.java b/src/java/org/apache/fop/apps/FOPException.java index cb8c4ca9c..f90a75272 100644 --- a/src/java/org/apache/fop/apps/FOPException.java +++ b/src/java/org/apache/fop/apps/FOPException.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,12 +42,12 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.apps; import org.xml.sax.SAXException; @@ -70,20 +70,37 @@ public class FOPException extends Exception { super(message); } + /** + * + * @param e Throwable object + */ public FOPException(Throwable e) { super(e.getMessage()); setException(e); } + /** + * + * @param message descriptive message + * @param e Throwable object + */ public FOPException(String message, Throwable e) { super(message); setException(e); } + /** + * Sets exception + * @param t Throwable object + */ protected void setException(Throwable t) { exception = t; } + /** + * Accessor for exception + * @return exception + */ public Throwable getException() { return exception; } @@ -104,7 +121,9 @@ public class FOPException extends Exception { return null; } - + /** + * Write stack trace to stderr + */ public void printStackTrace() { synchronized (System.err) { super.printStackTrace(); @@ -119,6 +138,10 @@ public class FOPException extends Exception { } } + /** + * write stack trace on a PrintStream + * @param stream PrintStream on which to write stack trace + */ public void printStackTrace(java.io.PrintStream stream) { synchronized (stream) { super.printStackTrace(stream); @@ -133,6 +156,10 @@ public class FOPException extends Exception { } } + /** + * Write stack trace on a PrintWriter + * @param writer PrintWriter on which to write stack trace + */ public void printStackTrace(java.io.PrintWriter writer) { synchronized (writer) { super.printStackTrace(writer); -- 2.39.5