org.codehaus.mojo.rmic

Class AbstractRmiMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.rmic.AbstractRmiMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

RmicMojo, TestRmicMojo

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

Generic super class of rmi compiler mojos.

Version:

$Id$

Author:

Trygve Laugstøl

Field Summary

Fields

Modifier and Type	Field and Description
protected String	compiler The id of the rmi compiler to use.
protected Set<String>	excludes A list of exclusions when searching for classes to compile.
protected Set<String>	includes A list of inclusions when searching for classes to compile.
protected org.apache.maven.project.MavenProject	project The maven project.

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

ROLE

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Main mojo execution.
abstract File	getClassesDirectory() Get the directory where Remote impl classes are located.
abstract File	getOutputDirectory() Get the directory where rmic generated class files are written.
abstract List<String>	getProjectClasspathElements() Get the list of elements to add to the classpath of rmic
void	setExcludes(Set<String> excludes) Specifies files to exclude from rmic processing
void	setIdl(Boolean idl) Specifies whether the '-idl' option will be passed to the compiler.
void	setIiop(Boolean iiop) Specifies whether the '-iiop' option will be passed to the compiler.
void	setIncludes(Set<String> includes) Specifies files to include in rmic processing
void	setKeep(Boolean keep) Specifies whether the '-keep' option will be passed to the compiler.
void	setNoLocalStubs(Boolean noLocalStubs) Specifies whether the '-nolocalstubs' option will be passed to the compiler.
void	setNoValueMethods(Boolean noValueMethods) Specifies whether the '-noValueMethods' option will be passed to the compiler.
void	setNowarn(Boolean nowarn) Specifies whether the '-warn' option will be passed to the compiler.
void	setPoa(Boolean poa) Specifies whether the '-poa' option will be passed to the compiler.
void	setVerbose(Boolean verbose) Specifies whether the '-verbose' option will be passed to the compiler.
void	setVersion(String version) Specifies a version to be passed to the compiler.

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

includes

@Parameter
protected Set<String> includes

A list of inclusions when searching for classes to compile.

excludes

@Parameter
protected Set<String> excludes

A list of exclusions when searching for classes to compile.

compiler

@Parameter(defaultValue="sun")
protected String compiler

The id of the rmi compiler to use.

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

The maven project.

Method Detail

getProjectClasspathElements

public abstract List<String> getProjectClasspathElements()

Get the list of elements to add to the classpath of rmic

Returns:

list of classpath elements

getOutputDirectory

public abstract File getOutputDirectory()

Get the directory where rmic generated class files are written.

Returns:

the directory

getClassesDirectory

public abstract File getClassesDirectory()

Get the directory where Remote impl classes are located.

Returns:

path to compiled classes

execute

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

Main mojo execution.

Throws:

org.apache.maven.plugin.MojoExecutionException - if there is a problem executing the mojo.

setIncludes

public void setIncludes(Set<String> includes)

Specifies files to include in rmic processing

Parameters:

includes - a set of file name patterns

setExcludes

public void setExcludes(Set<String> excludes)

Specifies files to exclude from rmic processing

Parameters:

excludes - a set of file name patterns

setVersion

public void setVersion(String version)

Specifies a version to be passed to the compiler. Defaults to not passing one.

Parameters:

version - the version to pass

setIiop

public void setIiop(Boolean iiop)

Specifies whether the '-iiop' option will be passed to the compiler.

Parameters:

iiop - if true, will pass the option

setNoLocalStubs

public void setNoLocalStubs(Boolean noLocalStubs)

Specifies whether the '-nolocalstubs' option will be passed to the compiler. Only applicable if the '-iiop' option is also set.

Parameters:

noLocalStubs - if true, will pass the option

setIdl

public void setIdl(Boolean idl)

Specifies whether the '-idl' option will be passed to the compiler.

Parameters:

idl - if true, will pass the option

setNoValueMethods

public void setNoValueMethods(Boolean noValueMethods)

Specifies whether the '-noValueMethods' option will be passed to the compiler. Only applicable if the '-idl' option is also set.

Parameters:

noValueMethods - if true, will pass the option

setKeep

public void setKeep(Boolean keep)

Specifies whether the '-keep' option will be passed to the compiler.

Parameters:

keep - if true, will pass the option

setNowarn

public void setNowarn(Boolean nowarn)

Specifies whether the '-warn' option will be passed to the compiler.

Parameters:

nowarn - if true, will pass the option

setPoa

public void setPoa(Boolean poa)

Specifies whether the '-poa' option will be passed to the compiler. Only applicable if the '-iiop' option is also set.

Parameters:

poa - if true, will pass the option

setVerbose

public void setVerbose(Boolean verbose)

Specifies whether the '-verbose' option will be passed to the compiler.

Parameters:

verbose - if true, will pass the option