org.codehaus.mojo.versions

Class AbstractVersionsDisplayMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

org.codehaus.mojo.versions.AbstractVersionsDisplayMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DisplayDependencyUpdatesMojo, DisplayParentUpdatesMojo, DisplayPluginUpdatesMojo, DisplayPropertyUpdatesMojo

public abstract class AbstractVersionsDisplayMojo
extends AbstractVersionsUpdaterMojo

Abstract base class for the Display___ mojos.

Author:

Stephen Connolly

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	logOutput Controls whether the display output is logged to the console.
protected String	outputEncoding The character encoding to use when writing to outputFile.
protected File	outputFile If specified then the display output will be sent to the specified file.
protected int	outputLineWidth Line width which should be used to format the padding of the version info list output.

Fields inherited from class org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

allowSnapshots, artifactMetadataSource, artifactResolver, ignoredVersions, localRepository, project, projectBuilder, reactorProjects, remoteArtifactRepositories, remotePluginRepositories, repositorySystem, ruleSet, session, settings

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractVersionsDisplayMojo(org.apache.maven.repository.RepositorySystem repositorySystem, org.apache.maven.project.MavenProjectBuilder projectBuilder, org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource, org.apache.maven.artifact.manager.WagonManager wagonManager, org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver)

Method Summary

Modifier and Type	Method and Description
protected int	getOutputLineWidthOffset()
protected void	logInit()
protected void	logLine(boolean error, String line)

Methods inherited from class org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

execute, findLatestVersion, getChangeRecorder, getHelper, getProject, getPropertyValue, getVersion, newModifiedPomXER, process, saveChangeRecorderResults, setProject, shouldApplyUpdate, shouldApplyUpdate, update, updatePropertyToNewestVersion, writeFile

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

outputFile

@Parameter(property="versions.outputFile")
protected File outputFile

If specified then the display output will be sent to the specified file.

Since:

2.2

logOutput

@Parameter(property="versions.logOutput",
           defaultValue="true")
protected boolean logOutput

Controls whether the display output is logged to the console.

Since:

2.2

outputEncoding

@Parameter(property="outputEncoding",
           defaultValue="${project.reporting.outputEncoding}")
protected String outputEncoding

The character encoding to use when writing to outputFile.

Since:

2.2

outputLineWidth

@Parameter(property="versions.outputLineWidth",
           defaultValue="80")
protected int outputLineWidth

Line width which should be used to format the padding of the version info list output.

Since:

2.10.0

Constructor Detail

AbstractVersionsDisplayMojo

@Inject
protected AbstractVersionsDisplayMojo(org.apache.maven.repository.RepositorySystem repositorySystem,
                                              org.apache.maven.project.MavenProjectBuilder projectBuilder,
                                              org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource,
                                              org.apache.maven.artifact.manager.WagonManager wagonManager,
                                              org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver)

Method Detail

logInit

protected void logInit()

logLine

protected void logLine(boolean error,
                       String line)

getOutputLineWidthOffset

protected int getOutputLineWidthOffset()

Returns:

Offset of the configured output line width compared to the default with of 80.