de.palsoftware.tools.maven.git.autover

Class ConfigHelper

java.lang.Object

de.palsoftware.tools.maven.git.autover.ConfigHelper

public class ConfigHelper
extends Object

Helper class to apply the maven extension configuration.

Since:

2018-06-15

Author:

Eduard Pal

Field Summary

Fields

Modifier and Type	Field and Description
static de.palsoftware.tools.maven.git.autover.conf.AutoverBranchConfig	DEFAULT_BUGFIX_CONFIG Default configuration for the bugfix branch.
static de.palsoftware.tools.maven.git.autover.conf.AutoverBranchConfig	DEFAULT_FEATURE_CONFIG Default configuration for the feature branch.
static de.palsoftware.tools.maven.git.autover.conf.AutoverBranchConfig	DEFAULT_MASTER_CONFIG Default configuration for the master branch.
static de.palsoftware.tools.maven.git.autover.conf.AutoverBranchConfig	DEFAULT_OTHER_CONFIG Default configuration for the other branches.
static de.palsoftware.tools.maven.git.autover.conf.AutoverBranchConfig	DEFAULT_PR_CONFIG Default configuration for the PR branch.
static de.palsoftware.tools.maven.git.autover.conf.AutoverBranchConfig	DEFAULT_RELEASE_CONFIG Default configuration for the release branch.
static String	DEFAULT_VERSION_TAG_REGEX The default version tag regular expression.
static String	TO_BE_CALCULATED_ARTIFACT_VERSION The marker artifact version that will indicate that the maven extension should calculate the version.

Constructor Summary

Constructors

Constructor and Description
ConfigHelper(AutoverConfigDecorator aConfig) Constructor.

Method Summary

Modifier and Type	Method and Description
String	calculateVer(GitAnalysisResult gitAnalysisResult) Calculate the version based on the configuration and the git analysis result.
AutoverBranchConfigDecorator	getBranchConfig(String branchName) Determine the branch configuration that needs to be used.
static de.palsoftware.tools.maven.git.autover.conf.AutoverConfig	getDefaultConfiguration() Get the default maven extension configuration (usually when none was found).
boolean	matchesTagRegEx(String tagShortName) Check if the specified tag matches the version tag regex.
boolean	shouldProcessArtifact(String version, String groupId, String artifactId) If the artifact with the specified id should be processed (the version should be calculated).

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VERSION_TAG_REGEX

public static final String DEFAULT_VERSION_TAG_REGEX

The default version tag regular expression.

See Also:

Constant Field Values

DEFAULT_MASTER_CONFIG

public static final de.palsoftware.tools.maven.git.autover.conf.AutoverBranchConfig DEFAULT_MASTER_CONFIG

Default configuration for the master branch.

DEFAULT_RELEASE_CONFIG

public static final de.palsoftware.tools.maven.git.autover.conf.AutoverBranchConfig DEFAULT_RELEASE_CONFIG

Default configuration for the release branch.

DEFAULT_FEATURE_CONFIG

public static final de.palsoftware.tools.maven.git.autover.conf.AutoverBranchConfig DEFAULT_FEATURE_CONFIG

Default configuration for the feature branch.

DEFAULT_BUGFIX_CONFIG

public static final de.palsoftware.tools.maven.git.autover.conf.AutoverBranchConfig DEFAULT_BUGFIX_CONFIG

Default configuration for the bugfix branch.

DEFAULT_PR_CONFIG

public static final de.palsoftware.tools.maven.git.autover.conf.AutoverBranchConfig DEFAULT_PR_CONFIG

Default configuration for the PR branch.

DEFAULT_OTHER_CONFIG

public static final de.palsoftware.tools.maven.git.autover.conf.AutoverBranchConfig DEFAULT_OTHER_CONFIG

Default configuration for the other branches.

TO_BE_CALCULATED_ARTIFACT_VERSION

public static final String TO_BE_CALCULATED_ARTIFACT_VERSION

The marker artifact version that will indicate that the maven extension should calculate the version.

See Also:

Constant Field Values

Constructor Detail

ConfigHelper

public ConfigHelper(AutoverConfigDecorator aConfig)

Constructor.

Parameters:

aConfig - the maven extension configuration to use

Method Detail

getDefaultConfiguration

public static de.palsoftware.tools.maven.git.autover.conf.AutoverConfig getDefaultConfiguration()

Get the default maven extension configuration (usually when none was found).

Returns:

the default maven extension configuration

shouldProcessArtifact

public boolean shouldProcessArtifact(String version,
                                     String groupId,
                                     String artifactId)

If the artifact with the specified id should be processed (the version should be calculated). we process only if version is not inherited (different than null) groupId is included the version is different than 0.0.0-SNAPSHOT

Parameters:

version - the version

groupId - the group id

artifactId - the artifact id

Returns:

true if the artifact should be processed and false otherwise

getBranchConfig

public AutoverBranchConfigDecorator getBranchConfig(String branchName)

Determine the branch configuration that needs to be used.

Parameters:

branchName - the branch name

Returns:

the branch configuration

calculateVer

public String calculateVer(GitAnalysisResult gitAnalysisResult)

Calculate the version based on the configuration and the git analysis result.

Parameters:

gitAnalysisResult - the git analysis result

Returns:

the calculated version

matchesTagRegEx

public boolean matchesTagRegEx(String tagShortName)

Check if the specified tag matches the version tag regex.

Parameters:

tagShortName - the tag

Returns:

true if it matches and false otherwise