de.smartics.tagcloud.maven
Class AbstractTagCloudMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      de.smartics.tagcloud.maven.AbstractTagCloudMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

TagCloudPropertyMojo, XmlExportMojo

public abstract class AbstractTagCloudMojo
     
     

      
      extends 
      
      AbstractMojo
     
     

Base implementation for tag cloud mojos.

Author:

Robert Reiner

Field Summary

protected String	basedir The base directory to scan files.
protected String	encoding Specifies the encoding to be used to read the source files.
protected String[]	excludes The filter for files to exclude to be passed to the tag collection..
protected String[]	includes The filter for files to include to be passed to the tag collection.
protected String	logLevel Specifies the log level used for this plugin.
protected MavenProject	project The Maven project.
protected boolean	skip A simple flag to skip the generation of the XML file.
protected boolean	useJavaReservedWordsFilter The filter removes Java reserved words from the tag cloud.
protected boolean	useUsualWordsFilter The filter removes usual Java words from the tag cloud.
protected String[]	wordsToFilter The list of words to be removed from the tag cloud.

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

ROLE

Constructor Summary

AbstractTagCloudMojo()

Method Summary

protected TagCloudFactory	createFactoryInstance()
void	execute()
protected abstract void	runWith(TagCloud tagCloud) Subclasses will get the generated cloud passed by overriding this method.

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 MavenProject project

The Maven project.

Since:

1.0

basedir

protected String basedir

The base directory to scan files.

Since:

1.0

includes

protected String[] includes

The filter for files to include to be passed to the tag collection.

Since:

1.0

excludes

protected String[] excludes

The filter for files to exclude to be passed to the tag collection..

Since:

1.0

skip

protected boolean skip

A simple flag to skip the generation of the XML file. If set on the command line use -Dtagcloud.skip.

Since:

1.0

logLevel

protected String logLevel

Specifies the log level used for this plugin.

Allowed values are SEVERE, WARNING, INFO and FINEST.

Since:

1.0

encoding

protected String encoding

Specifies the encoding to be used to read the source files.

Since:

1.0

useJavaReservedWordsFilter

protected boolean useJavaReservedWordsFilter

The filter removes Java reserved words from the tag cloud.

Since:

1.0

useUsualWordsFilter

protected boolean useUsualWordsFilter

The filter removes usual Java words from the tag cloud.

Since:

1.0

wordsToFilter

protected String[] wordsToFilter

The list of words to be removed from the tag cloud. This allows an individual configuration.

Since:

1.0

Constructor Detail

AbstractTagCloudMojo

public AbstractTagCloudMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Throws:

MojoExecutionException

MojoFailureException

runWith

protected abstract void runWith(TagCloud tagCloud)
                         throws MojoExecutionException

Subclasses will get the generated cloud passed by overriding this method.

Parameters:

tagCloud - the generated tag cloud.

Throws:

MojoExecutionException - on any problem encountered.

createFactoryInstance

protected TagCloudFactory createFactoryInstance()
                                         throws MojoExecutionException

Throws:

MojoExecutionException