net.sf.yal10n

Class BaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

net.sf.yal10n.BaseMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DashboardMojo, DetectChangesMojo

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

Base class for the mojos.

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceAnalyzer	analyzer The analyzer that finds resource bundles.
protected boolean	offline Whether to update the local workspace checkouts or not.
protected String	outputDirectory The directory where the dashboard html files should be created.
protected SVNUtil	svn The svn utility to do checkouts.
protected String	yal10nSettings The configuration of the dashboard is read from this file.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
BaseMojo() Instantiates a new base mojo.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkout(DashboardConfiguration config, DetectChangesStatus newStatus) Performs the svn checkout and collects the new revision status.
void	setOutputDirectory(String outputDirectory) Sets the output directory.
void	setYal10nSettings(String yal10nSettings) Sets the settings file name

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

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

execute

Field Detail

yal10nSettings

@Parameter(required=true,
           property="yal10n.settings",
           defaultValue="yal10n-settings.json")
protected String yal10nSettings

The configuration of the dashboard is read from this file. The file format is json.

offline

@Parameter(required=true,
           defaultValue="${settings.offline}")
protected boolean offline

Whether to update the local workspace checkouts or not.

outputDirectory

@Parameter(required=true,
           property="yal10n.outputDirectory",
           defaultValue="target")
protected String outputDirectory

The directory where the dashboard html files should be created.

svn

@Component
protected SVNUtil svn

The svn utility to do checkouts.

analyzer

@Component
protected ResourceAnalyzer analyzer

The analyzer that finds resource bundles.

Constructor Detail

BaseMojo

public BaseMojo()

Instantiates a new base mojo.

Method Detail

setYal10nSettings

public void setYal10nSettings(String yal10nSettings)

Sets the settings file name

Parameters:

yal10nSettings - the settings file name to use

setOutputDirectory

public void setOutputDirectory(String outputDirectory)

Sets the output directory.

Parameters:

outputDirectory - the new output directory

checkout

protected void checkout(DashboardConfiguration config,
            DetectChangesStatus newStatus)

Performs the svn checkout and collects the new revision status.

Parameters:

config - the configuration with all the repositories

newStatus - the new status. Can be null.