Package org.codehaus.mojo.buildhelper

Class ParseVersionMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.buildhelper.AbstractDefinePropertyMojo

org.codehaus.mojo.buildhelper.ParseVersionMojo

All Implemented Interfaces:

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

@Mojo(name="parse-version",
      defaultPhase=VALIDATE,
      threadSafe=true)
public class ParseVersionMojo
extends AbstractDefinePropertyMojo

Parse a version string and set properties containing the component parts of the version. This mojo sets the following properties:

   [propertyPrefix].majorVersion
   [propertyPrefix].minorVersion
   [propertyPrefix].incrementalVersion
   [propertyPrefix].qualifier
   [propertyPrefix].buildNumber
 

Where the propertyPrefix is the string set in the mojo parameter. The parsing of the above is based on the following format of the version:

  <majorversion [> . <minorversion [> . <incrementalversion ] ] [> - <buildnumber | qualifier ]>
 

It will be tried to parse the version as an OSGi version. It this is successful the following property will be set accordingly. If this is not possible a warning will be emitted.

   [propertyPrefix].osgiVersion
 

This goal also sets the following properties:

   [propertyPrefix].nextMajorVersion
   [propertyPrefix].nextMinorVersion
   [propertyPrefix].nextIncrementalVersion
   [propertyPrefix].nextBuildNumber
 

This goal also sets the following properties:

   [formattedPropertyPrefix].majorVersion
   [formattedPropertyPrefix].minorVersion
   [formattedPropertyPrefix].incrementalVersion
   [formattedPropertyPrefix].buildNumber
 

This goal also sets the following properties:

   [formattedPropertyPrefix].nextMajorVersion
   [formattedPropertyPrefix].nextMinorVersion
   [formattedPropertyPrefix].nextIncrementalVersion
   [formattedPropertyPrefix].nextBuildNumber
 

There is another property set which is named [propertyPrefix].qualifier and furthermore another property which is named [propertyPrefix].qualifier? which contains a prefix - if the qualifier contains anything otherwise the whole property is simply empty.

 mvn build-helper:parse-version versions:set \
   -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.nextMinorVersion}.\${parsedVersion.incrementalVersion}\${parsedVersion.qualifier?}
 

The above properties contain simply incremented versions of the parsed version informations. Those can now be used to update the version of your project via the following to the next Major version:

   mvn build-helper:parse-version versions:set \
      -DnewVersion=\${parsedVersion.nextMajorVersion}.0.0 \
      versions:commit
 

It can of course being used to increment the minor version:

   mvn build-helper:parse-version versions:set \
      -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.nextMinorVersion}.0 \
      versions:commit
 

This can make an upgrade of the versions of your project very convenient.

Since:

1.3

Author:

pgier

Field Summary

Fields inherited from class org.codehaus.mojo.buildhelper.AbstractDefinePropertyMojo

project

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

ROLE

Constructor Summary

Constructors

Constructor	Description
ParseVersionMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Execute the mojo.
void	parseVersion(String version)	Parse a version String and add the components to a properties object.
void	setFormatBuildNumber(String formatBuildNumber)
void	setFormatIncremental(String formatIncremental)
void	setFormatMajor(String formatMajor)
void	setFormatMinor(String formatMinor)
void	setFormattedPropertyPrefix(String formattedPropertyPrefix)
void	setPropertyPrefix(String prefix)	Set property name prefix.

Methods inherited from class org.codehaus.mojo.buildhelper.AbstractDefinePropertyMojo

defineProperty, getProject

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

Constructor Details

ParseVersionMojo

public ParseVersionMojo()

Method Details

execute

public void execute()

Execute the mojo. This sets the version properties on the project.

parseVersion

public void parseVersion(String version)

Parse a version String and add the components to a properties object.

Parameters:

version - the version to parse

setPropertyPrefix

public void setPropertyPrefix(String prefix)

Set property name prefix.

Parameters:

prefix - The prefix to be used.

setFormattedPropertyPrefix

public void setFormattedPropertyPrefix(String formattedPropertyPrefix)

Parameters:

formattedPropertyPrefix - The prefix used for formatted properties.

setFormatMajor

public void setFormatMajor(String formatMajor)

Parameters:

formatMajor - Set the format for major part.

setFormatMinor

public void setFormatMinor(String formatMinor)

Parameters:

formatMinor - Set the format for minor part.

setFormatIncremental

public void setFormatIncremental(String formatIncremental)

Parameters:

formatIncremental - Set format for incremental part.

setFormatBuildNumber

public void setFormatBuildNumber(String formatBuildNumber)

Parameters:

formatBuildNumber - Set the format for the buildNumber part.