org.apache.avro.mojo

Class AbstractAvroMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.avro.mojo.AbstractAvroMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

IDLProtocolMojo, ProtocolMojo, SchemaMojo

public abstract class AbstractAvroMojo
extends org.apache.maven.plugin.AbstractMojo

Base for Avro Compiler Mojos.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	createSetters Determines whether or not to create setters for the fields of the record.
protected String[]	excludes A set of Ant-like exclusion patterns used to prevent certain files from being processed.
protected String[]	imports A list of files or directories that should be compiled first thus making them importable by subsequently compiled schemas.
protected org.apache.maven.project.MavenProject	project The current Maven project.
protected String	stringType The Java type to use for Avro strings.
protected String	templateDirectory The directory (within the java classpath) that contains the velocity templates to use for code generation.
protected String[]	testExcludes A set of Ant-like exclusion patterns used to prevent certain files from being processed.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractAvroMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doCompile(String filename, File sourceDirectory, File outputDirectory)
void	execute()
protected SpecificCompiler.FieldVisibility	getFieldVisibility()
protected abstract String[]	getIncludes()
protected abstract String[]	getTestIncludes()

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

imports

protected String[] imports

A list of files or directories that should be compiled first thus making them importable by subsequently compiled schemas. Note that imported files should not reference each other.

Is defined by:

excludes

protected String[] excludes

A set of Ant-like exclusion patterns used to prevent certain files from being processed. By default, this set is empty such that no files are excluded.

Is defined by:

testExcludes

protected String[] testExcludes

A set of Ant-like exclusion patterns used to prevent certain files from being processed. By default, this set is empty such that no files are excluded.

Is defined by:

stringType

protected String stringType

The Java type to use for Avro strings. May be one of CharSequence, String or Utf8. CharSequence by default.

Is defined by:

expression:

${stringType}

templateDirectory

protected String templateDirectory

The directory (within the java classpath) that contains the velocity templates to use for code generation. The default value points to the templates included with the avro-maven-plugin.

Is defined by:

expression:

${templateDirectory}

createSetters

protected boolean createSetters

Determines whether or not to create setters for the fields of the record. The default is to create setters.

Is defined by:

default-value:

true

project

protected org.apache.maven.project.MavenProject project

The current Maven project.

Is defined by:

default-value:

${project}

Is required.

Is readonly.

Constructor Detail

AbstractAvroMojo

public AbstractAvroMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getFieldVisibility

protected SpecificCompiler.FieldVisibility getFieldVisibility()

doCompile

protected abstract void doCompile(String filename,
             File sourceDirectory,
             File outputDirectory)
                           throws IOException

Throws:

IOException

getIncludes

protected abstract String[] getIncludes()

getTestIncludes

protected abstract String[] getTestIncludes()