net.talvi.puffinplot

Class Version

java.lang.Object

net.talvi.puffinplot.Version

public class Version
extends java.lang.Object

A class containing information about PuffinPlot's version.

Method Summary

Modifier and Type	Method and Description
static Version	fromGitProperties(java.util.function.UnaryOperator<java.lang.String> propertyFetcher) Provides a version object corresponding to some supplied git build properties.
static Version	fromMercurialProperties(java.util.function.UnaryOperator<java.lang.String> propertyFetcher) Provides a version object corresponding to some supplied Mercurial build properties.
java.lang.String	getDateString()
java.lang.String	getVersionString()
java.lang.String	getYearRange()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fromMercurialProperties

public static Version fromMercurialProperties(java.util.function.UnaryOperator<java.lang.String> propertyFetcher)

Provides a version object corresponding to some supplied Mercurial build properties. This factory takes as its argument a property fetcher function which turns a property name into its value. It returns a version object with values initialized from the values of properties named build.hg.revid (revision ID), build.hg.date (date of revision), build.hg.tag (version tag of revision, if any), and build.date (date of build).

Parameters:

propertyFetcher - a function which returns property values for supplied property names

Returns:

a version object corresponding to the values returned by the property fetcher

fromGitProperties

public static Version fromGitProperties(java.util.function.UnaryOperator<java.lang.String> propertyFetcher)

Provides a version object corresponding to some supplied git build properties. This factory takes as its argument a property fetcher function which turns a property name into its value. It returns a version object with values initialized from the values of properties named build.git.hash (revision ID), build.git.committerdate (committer date of revision), build.git.tag (version tag of revision, if any), and build.date (date of build).

Parameters:

propertyFetcher - a function which returns property values for supplied property names

Returns:

a version object corresponding to the values returned by the property fetcher

getVersionString

public java.lang.String getVersionString()

Returns:

a string representing this Version

getDateString

public java.lang.String getDateString()

Returns:

a string representing the release date of this Version

getYearRange

public java.lang.String getYearRange()

Returns:

a string representing the copyright year range of this Version