org.apache.maven.dotnet.executable.compiler.impl
Class PhpCompiler

java.lang.Object
  org.apache.maven.dotnet.executable.compiler.impl.PhpCompiler

All Implemented Interfaces:

CompilerExecutable, NetExecutable

public final class PhpCompiler
extends java.lang.Object

Compiler for PHP (http://php4mono.sourceforge.net/)

Author:

Shane Isbell

Field Summary

protected CompilerContext	compilerContext The context that the compiler implementation can use to obtain information to customize the compile.
protected org.codehaus.plexus.logging.Logger	logger A logger for writing log messages

Constructor Summary

PhpCompiler()

Method Summary

void	execute() Compiles class files.
boolean	failOnErrorOutput() Returns true to fail the build if the compiler writes anything to the error stream, otherwise return false.
java.util.List<java.lang.String>	getCommands() Returns the commands that this compiler will use to compile the application.
java.io.File	getCompiledArtifact() Returns a file pointing to the compiled artifact for this executable.
java.lang.String	getExecutable() Returns the executable file name that this compiler will use to compile the application.
java.io.File	getExecutionPath() Returns the parent directory of the executable.
Vendor	getVendor() Returns vendor framework used to run executable.
void	init(NMavenContext nmavenContext) This method may be overridden if the developer needs to create a profile of one of the other compilers.
void	resetCommands(java.util.List<java.lang.String> commands) Resets the commands to be used by the executable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

compilerContext

protected CompilerContext compilerContext

The context that the compiler implementation can use to obtain information to customize the compile.

logger

protected org.codehaus.plexus.logging.Logger logger

A logger for writing log messages

Constructor Detail

PhpCompiler

public PhpCompiler()

Method Detail

failOnErrorOutput

public boolean failOnErrorOutput()

Description copied from interface: CompilerExecutable

Returns true to fail the build if the compiler writes anything to the error stream, otherwise return false.

Returns:

true to fail the build if the compiler writes anything to the error stream, otherwise return false

getCommands

public java.util.List<java.lang.String> getCommands()
                                             throws ExecutionException

Description copied from interface: NetExecutable

Returns the commands that this compiler will use to compile the application. This list is unmodifiable.

Returns:

the commands that this compiler will use to compile the application

Throws:

ExecutionException

resetCommands

public void resetCommands(java.util.List<java.lang.String> commands)

Description copied from interface: NetExecutable

Resets the commands to be used by the executable. This should only be used if the executable is being reused with different commands from the one that it was initialized with.

init

public void init(NMavenContext nmavenContext)

This method may be overridden if the developer needs to create a profile of one of the other compilers.

Specified by:

init in interface NetExecutable

getCompiledArtifact

public java.io.File getCompiledArtifact()
                                 throws InvalidArtifactException

Description copied from interface: CompilerExecutable

Returns a file pointing to the compiled artifact for this executable.

Specified by:

getCompiledArtifact in interface CompilerExecutable

Returns:

a file pointing to the compiled artifact for this executable

Throws:

InvalidArtifactException - if the artifact is invalid

See Also:

CompilerExecutable.getCompiledArtifact()

getExecutable

public java.lang.String getExecutable()
                               throws ExecutionException

Description copied from interface: NetExecutable

Returns the executable file name that this compiler will use to compile the application.

Specified by:

getExecutable in interface NetExecutable

Returns:

the executable file name that this compiler will use to compile the application

Throws:

ExecutionException

See Also:

NetExecutable.getExecutable()

getExecutionPath

public java.io.File getExecutionPath()

Description copied from interface: NetExecutable

Returns the parent directory of the executable.

Specified by:

getExecutionPath in interface NetExecutable

Returns:

the parent directory of the executable

See Also:

NetExecutable.getExecutionPath()

execute

public void execute()
             throws ExecutionException

Description copied from interface: NetExecutable

Compiles class files.

Specified by:

execute in interface NetExecutable

Throws:

ExecutionException - if the compiler writes to the standard error stream. artifact (module, library, exe, winexe) or the target artifact is not valid for the compiler

See Also:

NetExecutable.execute()

getVendor

public Vendor getVendor()

Description copied from interface: NetExecutable

Returns vendor framework used to run executable.

Specified by:

getVendor in interface NetExecutable

Returns:

vendor vendor framework used to run executable