vgritsenko 2003/03/11 08:01:48
Modified: src/java/org/apache/cocoon/components/language/programming
LanguageCompiler.java
Log:
Align code, fix javadoc
Revision Changes Path
1.2 +55 -57
cocoon-2.1/src/java/org/apache/cocoon/components/language/programming/LanguageCompiler.java
Index: LanguageCompiler.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/components/language/programming/LanguageCompiler.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- LanguageCompiler.java 9 Mar 2003 00:08:59 -0000 1.1
+++ LanguageCompiler.java 11 Mar 2003 16:01:48 -0000 1.2
@@ -58,65 +58,63 @@
/**
* This interface defines a compiler's functionality for all
* (Java-based) compiled languages
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Stefano Mazzocchi</a>
* @version CVS $Id$
* @since 2.0
*/
public interface LanguageCompiler extends Component {
- /**
- * Set the name of the file containing the source program
- *
- * @param file The name of the file containing the source program
- */
- void setFile(String file);
-
- /**
- * Set the name of the directory containing the source program file
- *
- * @param srcDir The name of the directory containing the source program file
- */
- void setSource(String srcDir);
-
- /**
- * Set the name of the directory to contain the resulting object program file
- *
- * @param destDir The name of the directory to contain the resulting object
- * program file
- */
- void setDestination(String destDir);
-
- /**
- * Set the classpath to be used for this compilation
- *
- * @param classpath The classpath to be used for this compilation
- */
- void setClasspath(String classpath);
-
- /**
- * Set the encoding of the input source file or <code>null</code> to use the
- * platform's default encoding
- *
- * @param encoding The encoding of the input source file or <code>null</code>
- * to use the platform's default encoding
- */
- void setEncoding(String encoding);
-
- /**
- * Compile a source file yielding a loadable program file.
- *
- * @param filename The object program base file name
- * @param baseDirectory The directory containing the object program file
- * @param encoding The encoding expected in the source file or
- * <code>null</code> if it is the platform's default encoding
- * @exception LanguageException If an error occurs during compilation
- */
- boolean compile() throws IOException;
-
- /**
- * Return the list of errors generated by this compilation
- *
- * @return The list of errors generated by this compilation
- * @exception IOException If an error occurs during message collection
- */
- List getErrors() throws IOException;
+
+ /**
+ * Set the name of the file containing the source program
+ *
+ * @param file The name of the file containing the source program
+ */
+ void setFile(String file);
+
+ /**
+ * Set the name of the directory containing the source program file
+ *
+ * @param srcDir The name of the directory containing the source program file
+ */
+ void setSource(String srcDir);
+
+ /**
+ * Set the name of the directory to contain the resulting object program file
+ *
+ * @param destDir The name of the directory to contain the resulting object
+ * program file
+ */
+ void setDestination(String destDir);
+
+ /**
+ * Set the classpath to be used for this compilation
+ *
+ * @param classpath The classpath to be used for this compilation
+ */
+ void setClasspath(String classpath);
+
+ /**
+ * Set the encoding of the input source file or <code>null</code> to use the
+ * platform's default encoding
+ *
+ * @param encoding The encoding of the input source file or <code>null</code>
+ * to use the platform's default encoding
+ */
+ void setEncoding(String encoding);
+
+ /**
+ * Compile a source file yielding a loadable program file.
+ *
+ * @exception IOException If an error occurs during compilation
+ */
+ boolean compile() throws IOException;
+
+ /**
+ * Return the list of errors generated by this compilation
+ *
+ * @return The list of errors generated by this compilation
+ * @exception IOException If an error occurs during message collection
+ */
+ List getErrors() throws IOException;
}
