org.hawkular.build.license

Class CopyrightRangeProvider

java.lang.Object

org.hawkular.build.license.CopyrightRangeProvider

All Implemented Interfaces:

com.mycila.maven.plugin.license.PropertiesProvider

public class CopyrightRangeProvider
extends Object
implements com.mycila.maven.plugin.license.PropertiesProvider

An implementation of PropertiesProvider that adds "license.copyrightLastYear" and "license.copyrightYears" values - see getAdditionalProperties(AbstractLicenseMojo, Properties, Document).

Author:

Peter Palaga

Field Summary

Fields

Modifier and Type	Field and Description
static String	COPYRIGHT_LAST_YEAR_KEY
static String	COPYRIGHT_LAST_YEAR_MAX_COMMITS_LOOKUP_KEY
static String	COPYRIGHT_LAST_YEAR_SOURCE_KEY
static String	COPYRIGHT_LAST_YEAR_TIME_ZONE_KEY
static String	COPYRIGHT_YEARS_KEY
static String	INCEPTION_YEAR_KEY

Constructor Summary

Constructors

Constructor and Description
CopyrightRangeProvider()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAdditionalProperties(com.mycila.maven.plugin.license.AbstractLicenseMojo mojo, Properties properties, com.mycila.maven.plugin.license.document.Document document) Returns an unmodifiable map containing two entries "license.copyrightLastYear" and "license.copyrightYears" whose values are set based on inspecting git history.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT_LAST_YEAR_KEY

public static final String COPYRIGHT_LAST_YEAR_KEY

See Also:

Constant Field Values

COPYRIGHT_LAST_YEAR_MAX_COMMITS_LOOKUP_KEY

public static final String COPYRIGHT_LAST_YEAR_MAX_COMMITS_LOOKUP_KEY

See Also:

Constant Field Values

COPYRIGHT_LAST_YEAR_SOURCE_KEY

public static final String COPYRIGHT_LAST_YEAR_SOURCE_KEY

See Also:

Constant Field Values

COPYRIGHT_LAST_YEAR_TIME_ZONE_KEY

public static final String COPYRIGHT_LAST_YEAR_TIME_ZONE_KEY

See Also:

Constant Field Values

COPYRIGHT_YEARS_KEY

public static final String COPYRIGHT_YEARS_KEY

See Also:

Constant Field Values

INCEPTION_YEAR_KEY

public static final String INCEPTION_YEAR_KEY

See Also:

Constant Field Values

Constructor Detail

CopyrightRangeProvider

public CopyrightRangeProvider()

Method Detail

getAdditionalProperties

public Map<String,String> getAdditionalProperties(com.mycila.maven.plugin.license.AbstractLicenseMojo mojo,
                                                  Properties properties,
                                                  com.mycila.maven.plugin.license.document.Document document)

Returns an unmodifiable map containing two entries "license.copyrightLastYear" and "license.copyrightYears" whose values are set based on inspecting git history.

• "license.copyrightLastYear" key stores the year from the commiter date of the last git commit that has modified the supplied document.
• "license.copyrightYears" key stores the range from "project.inceptionYear" value to "license.copyrightLastYear" value. If both values a equal, only the "project.inceptionYear" value is returned; otherwise, the two values are combined using dash, so that the result is e.g. "2000 - 2010".

The "project.inceptionYear" value is read from the supplied properties and it must available. Otherwise a RuntimeException is thrown.

Specified by:

getAdditionalProperties in interface com.mycila.maven.plugin.license.PropertiesProvider