io.protostuff.mojo

Class ProtoCompilerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.protostuff.mojo.ProtoCompilerMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class ProtoCompilerMojo
extends org.apache.maven.plugin.AbstractMojo

Compiles proto files to java/gwt/etc.

Author:

David Yu

Is defined by the goal name:

compile

Requires the dependencies in this specified scope:

runtime

Date created:

Jan 14, 2010

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	baseDir
protected java.io.File	modulesFile The properties file that contains the modules
protected java.io.File	outputBaseDir If not specified, the directory where the file is located will be used as its base dir.
protected org.apache.maven.project.MavenProject	project The current Maven project.
protected ProtoModule[]	protoModules The modules to generate code from
protected java.io.File	sourceBaseDir If not specified, the directory where the file is located will be used as its base dir.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
ProtoCompilerMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
protected boolean	skipMojo() Determine if the mojo execution should get skipped.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

project

protected org.apache.maven.project.MavenProject project

The current Maven project.

Since:

1.0.1

Is defined by:

default-value:

${project}

Is readonly.

Is required.

modulesFile

protected java.io.File modulesFile

The properties file that contains the modules

Is defined by:

sourceBaseDir

protected java.io.File sourceBaseDir

If not specified, the directory where the file is located will be used as its base dir.

This is only relevent when is provided.

Since:

1.0.8

Is defined by:

outputBaseDir

protected java.io.File outputBaseDir

If not specified, the directory where the file is located will be used as its base dir.

This is only relevent when is provided.

Since:

1.0.8

Is defined by:

protoModules

protected ProtoModule[] protoModules

The modules to generate code from

Is defined by:

baseDir

protected java.io.File baseDir

Is defined by:

expression:

${project.basedir}

Is required.

Constructor Detail

ProtoCompilerMojo

public ProtoCompilerMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

skipMojo

protected boolean skipMojo()

Determine if the mojo execution should get skipped.

This is the case if:

• skip is true
• if the mojo gets executed on a project with packaging type 'pom' and forceMojoExecution is false

Returns:

true if the mojo execution should be skipped.

Since:

1.0.1