org.apache.cocoon.components.language.programming
Interface LanguageCompiler

All Superinterfaces:

org.apache.avalon.framework.component.Component

All Known Implementing Classes:

AbstractJavaCompiler

public interface LanguageCompiler

extends org.apache.avalon.framework.component.Component

This interface defines a compiler's functionality for all (Java-based) compiled languages

Since:

2.0

Version:

CVS $Id: LanguageCompiler.java,v 1.5 2002/02/22 07:00:09 cziegeler Exp $

Author:

Stefano Mazzocchi

Method Summary

boolean	compile() Compile a source file yielding a loadable program file.
java.util.List	getErrors() Return the list of errors generated by this compilation
void	setClasspath(java.lang.String classpath) Set the classpath to be used for this compilation
void	setDestination(java.lang.String destDir) Set the name of the directory to contain the resulting object program file
void	setEncoding(java.lang.String encoding) Set the encoding of the input source file or null to use the platform's default encoding
void	setFile(java.lang.String file) Set the name of the file containing the source program
void	setSource(java.lang.String srcDir) Set the name of the directory containing the source program file

Method Detail

setFile

public void setFile(java.lang.String file)

Set the name of the file containing the source program

Parameters:

file - The name of the file containing the source program

setSource

public void setSource(java.lang.String srcDir)

Set the name of the directory containing the source program file

Parameters:

srcDir - The name of the directory containing the source program file

setDestination

public void setDestination(java.lang.String destDir)

Set the name of the directory to contain the resulting object program file

Parameters:

destDir - The name of the directory to contain the resulting object program file

setClasspath

public void setClasspath(java.lang.String classpath)

Set the classpath to be used for this compilation

Parameters:

classpath - The classpath to be used for this compilation

setEncoding

public void setEncoding(java.lang.String encoding)

Set the encoding of the input source file or null to use the platform's default encoding

Parameters:

encoding - The encoding of the input source file or null to use the platform's default encoding

compile

public boolean compile()
                throws java.io.IOException

Compile a source file yielding a loadable program file.

Parameters:

filename - The object program base file name

baseDirectory - The directory containing the object program file

encoding - The encoding expected in the source file or null if it is the platform's default encoding

Throws:

LanguageException - If an error occurs during compilation

getErrors

public java.util.List getErrors()
                         throws java.io.IOException

Return the list of errors generated by this compilation

Returns:

The list of errors generated by this compilation

Throws:

java.io.IOException - If an error occurs during message collection