pbwest 2003/07/10 21:03:47
Modified: src/java/org/apache/fop/apps Tag: FOP_0-20-0_Alt-Design
FOPException.java Options.java Driver.java
Log:
Fix Javadocs generation warnings.
Revision Changes Path
No revision
No revision
1.2.2.3 +14 -11 xml-fop/src/java/org/apache/fop/apps/FOPException.java
Index: FOPException.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/apps/FOPException.java,v
retrieving revision 1.2.2.2
retrieving revision 1.2.2.3
diff -u -r1.2.2.2 -r1.2.2.3
--- FOPException.java 10 Jul 2003 11:26:28 -0000 1.2.2.2
+++ FOPException.java 11 Jul 2003 04:03:47 -0000 1.2.2.3
@@ -57,7 +57,6 @@
/**
* Exception thrown when FOP has a problem
- * @author pbw
*/
public class FOPException extends Exception {
private static final String TAG = "$Name$";
@@ -69,8 +68,7 @@
/**
* create a new FOP Exception
- *
- * @param message descriptive message
+ * @param message description
*/
public FOPException(String message) {
super(message);
@@ -78,7 +76,6 @@
/**
* create a new FOP Exception
- *
* @param e incoming Throwable
*/
public FOPException(Throwable e) {
@@ -87,8 +84,8 @@
}
/**
- * @param message
- * @param e
+ * @param message the description
+ * @param e the exception
*/
public FOPException(String message, Throwable e) {
super(message);
@@ -96,21 +93,24 @@
}
/**
- * @param t
+ * Sets this exception to the Throwable parameter
+ * @param t the exception
*/
protected void setException(Throwable t) {
exception = t;
}
/**
- * @return
+ * Gets this exception.
+ * @return a Throwable
*/
public Throwable getException() {
return exception;
}
/**
- * @return
+ * Gets the root exception of this exception.
+ * @return the Throwable root exception
*/
protected Throwable getRootException() {
Throwable result = exception;
@@ -129,7 +129,7 @@
}
- /* (non-Javadoc)
+ /**
* @see java.lang.Throwable#printStackTrace()
*/
public void printStackTrace() {
@@ -146,6 +146,9 @@
}
}
+ /**
+ * @see java.lang.Throwable#printStackTrace(java.io.PrintStream)
+ */
public void printStackTrace(java.io.PrintStream stream) {
synchronized (stream) {
super.printStackTrace(stream);
@@ -160,7 +163,7 @@
}
}
- /* (non-Javadoc)
+ /**
* @see java.lang.Throwable#printStackTrace(java.io.PrintWriter)
*/
public void printStackTrace(java.io.PrintWriter writer) {
1.1.2.2 +3 -2 xml-fop/src/java/org/apache/fop/apps/Attic/Options.java
Index: Options.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/apps/Attic/Options.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- Options.java 5 Jul 2003 19:04:50 -0000 1.1.2.1
+++ Options.java 11 Jul 2003 04:03:47 -0000 1.1.2.2
@@ -361,7 +361,8 @@
/**
* Convenience class for common functionality required by the config
* files.
- * @param <tt>Class</tt> object of requesting class.
+ * @param fname the configuration file name.
+ * @param classobj the <tt>Class</tt> object of requesting class.
* @return an <tt>InputStream</tt> generated through a call to
* <tt>getResourceAsStream</tt> on the context <tt>ClassLoader</tt>
* or the <tt>ClassLoader</tt> for the conf class provided as an argument.
1.9.2.2 +56 -9 xml-fop/src/java/org/apache/fop/apps/Driver.java
Index: Driver.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/apps/Driver.java,v
retrieving revision 1.9.2.1
retrieving revision 1.9.2.2
diff -u -r1.9.2.1 -r1.9.2.2
--- Driver.java 5 Jul 2003 19:04:50 -0000 1.9.2.1
+++ Driver.java 11 Jul 2003 04:03:47 -0000 1.9.2.2
@@ -65,10 +65,15 @@
import org.apache.fop.xml.FoXMLSerialHandler;
import org.apache.fop.xml.SyncedFoXmlEventsBuffer;
+/**
+ * Sets up and runs serialized component threads.
+ * XMLEventSource <=> FOTree <=> AreaTree ...
+ *
+ * @author pbw
+ */
+
public class Driver {
- /**
- * If true, full error stacks are reported
- */
+ /** If true, full error stacks are reported */
private static boolean _errorDump = false;
private InputHandler inputHandler;
@@ -88,10 +93,7 @@
/**
- * What does the Driver do?
- * When it has all of the ancillary requirements, it sets up the
- * serialized components:
- * XMLEventSource <=> FOTree <=> AreaTree ...
+ * Error handling, version and logging initialization.
*/
public Driver() throws FOPException {
_errorDump =
@@ -100,6 +102,35 @@
MessageHandler.logln(version);
}
+ /**
+ * Sets up the environment and start processing threads.
+ * The primary elements of the environment include:<br>
+ * the input source, the parser, the
+ * [EMAIL PROTECTED] org.apache.fop.xml.SyncedFoXmlEventsBuffer
SyncedFoXmlEventsBuffer}
+ * (<code>xmlevents</code>), the
+ * [EMAIL PROTECTED] org.apache.fop.xml.FoXMLSerialHandler FoXMLSerialHandler}
+ * (<code>xmlhandler</code>) and the
+ * [EMAIL PROTECTED] org.apache.fop.fo.FOTree FOTree} (<code>foTree</code>).
+ *
+ * <p>The <code>xmlhandler</code> uses the source and the parser to
+ * generate XML events which it stores in <code>xmlevents</code>.
+ * <code>FoXMLSerialHandler</code> implements <code>Runnable</code>.
+ *
+ * <p>The <code>foTree</code> reads events from the <code>xmlevents</code>
+ * buffer, which it interprets to build the FO tree. <code>FOTree</code>
+ * implements <code>Runnable</code>.
+ *
+ * <p>The parser thread is passed the runnable <code>xmlhandler</code>.
+ * When started, it scans the input, constructs and buffers events. It
+ * blocks when the buffer is full, and continues when notified that the
+ * buffer has emptied.
+ * <p>
+ * The FO Tree builder thread is passed the runnable <code>foTree</code>,
+ * which blocks on an empty <code>xmlevents</code> buffer, and continues
+ * when notified that events are available in the buffer.
+ *
+ * @throws FOPException
+ */
public void run () throws FOPException {
setInputHandler(Options.getInputHandler());
parser = inputHandler.getParser();
@@ -134,6 +165,13 @@
}
+ /**
+ * Gets the parser Class name.
+ *
+ * @return a String with the value of the property
+ * <code>org.xml.sax.parser</code> or the default value
+ * <code>org.apache.xerces.parsers.SAXParser</code>.
+ */
public static final String getParserClassName() {
String parserClassName = null;
try {
@@ -146,11 +184,19 @@
return parserClassName;
}
+ /**
+ * Sets the InputHandler for XML imput as specified in Options.
+ * @param inputHandler the InputHandler
+ */
public void setInputHandler(InputHandler inputHandler) {
this.inputHandler = inputHandler;
}
- // setting the parser features
+ /**
+ * Sets the parser features.
+ * @param parser the XMLReader used to parse the input
+ * @throws FOPException
+ */
public void setParserFeatures(XMLReader parser) throws FOPException {
try {
parser.setFeature("http://xml.org/sax/features/namespace-prefixes";,
@@ -163,7 +209,8 @@
}
/**
- * Dumps an error
+ * Prints stack trace of an exception
+ * @param e the exception to trace
*/
public static void dumpError(Exception e) {
if (_errorDump) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
