org.codehaus.plexus.compiler
Interface Compiler

All Known Implementing Classes:
AbstractCompiler

public interface Compiler

Version:
$Id: Compiler.java 2723 2005-10-15 14:58:55Z brett $
Author:
Jason van Zyl, Trygve Laugstøl, Matthew Pocock

Field Summary
static java.lang.String ROLE
           
 
Method Summary
 boolean canUpdateTarget(CompilerConfiguration configuration)
           
 java.util.List compile(CompilerConfiguration configuration)
           
 java.lang.String[] createCommandLine(CompilerConfiguration config)
          Create the command line that would be executed using this configuration.
 CompilerOutputStyle getCompilerOutputStyle()
           
 java.lang.String getInputFileEnding(CompilerConfiguration configuration)
           
 java.lang.String getOutputFile(CompilerConfiguration configuration)
           
 java.lang.String getOutputFileEnding(CompilerConfiguration configuration)
           
 

Field Detail

ROLE

public static final java.lang.String ROLE
Method Detail

getCompilerOutputStyle

public CompilerOutputStyle getCompilerOutputStyle()

getInputFileEnding

public java.lang.String getInputFileEnding(CompilerConfiguration configuration)
                                    throws CompilerException
Throws:
CompilerException

getOutputFileEnding

public java.lang.String getOutputFileEnding(CompilerConfiguration configuration)
                                     throws CompilerException
Throws:
CompilerException

getOutputFile

public java.lang.String getOutputFile(CompilerConfiguration configuration)
                               throws CompilerException
Throws:
CompilerException

canUpdateTarget

public boolean canUpdateTarget(CompilerConfiguration configuration)
                        throws CompilerException
Throws:
CompilerException

compile

public java.util.List compile(CompilerConfiguration configuration)
                       throws CompilerException
Throws:
CompilerException

createCommandLine

public java.lang.String[] createCommandLine(CompilerConfiguration config)
                                     throws CompilerException
Create the command line that would be executed using this configuration. If this particular compiler has no concept of a command line then returns null.

Parameters:
config - the CompilerConfiguration describing the compilation
Returns:
an array of Strings that make up the command line, or null if this compiler has no concept of command line
Throws:
CompilerException - if there was an error generating the command line


Copyright © 2001-2007 Codehaus. All Rights Reserved.