info.ronjenkins.maven.rtr

Class RTRConfig

java.lang.Object

info.ronjenkins.maven.rtr.RTRConfig

public final class RTRConfig
extends Object

Configuration parser/constants for the Smart Reactor.

Author:

Ronald Jack Jenkins Jr.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ADDSCHEMA
static boolean	DEFAULT_ALLOWTIMESTAMPEDSNAPSHOTS
static boolean	DEFAULT_AUTOVERSIONSUBMODULES
static boolean	DEFAULT_DISABLED
static boolean	DEFAULT_EXTERNAL_SNAPSHOTS_ALLOWED
static String	DEFAULT_PROJECTVERSIONPOLICYID
static boolean	DEFAULT_RELEASE
static boolean	DEFAULT_SINGLE_POM_REACTOR_ALLOWED
static String	PROP_ADDSCHEMA
static String	PROP_ALLOWTIMESTAMPEDSNAPSHOTS
static String	PROP_AUTOVERSIONSUBMODULES
static String	PROP_DISABLED
static String	PROP_EXTERNAL_SNAPSHOTS_ALLOWED
static String	PROP_PROJECTVERSIONPOLICYID
static String	PROP_RELEASE
static String	PROP_RELEASEVERSION
static String	PROP_SINGLE_POM_REACTOR_ALLOWED
static String	PROP_TAG
static String	PROP_TAGBASE
static String	PROP_TAGNAMEFORMAT

Method Summary

Methods

Modifier and Type	Method and Description
static String	getProjectVersionPolicyId(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project) Returns the "projectVersionPolicyId" property.
static String	getReleaseVersion(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project) Returns the "releaseVersion" property.
static String	getTag(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project) Returns the "tag" property.
static String	getTagBase(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project) Returns the "tagBase" property.
static String	getTagNameFormat(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project) Returns the "tagNameFormat" property.
static boolean	isAddSchema(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project) Returns the "addSchema" property.
static boolean	isAllowTimestampedSnapshots(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project) Returns the "allowTimestampedSnapshots" property.
static boolean	isAutoVersionSubmodules(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project) Returns the "autoVersionSubmodules" property.
static boolean	isDisabled(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project) Indicates whether or not the Smart Reactor is disabled.
static boolean	isExternalSnapshotsAllowed(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project) Indicates whether or not the Smart Reactor should allow a release reactor containing references to any non-reactor SNAPSHOT artifacts.
static boolean	isRelease(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project) Indicates whether or not a release was requested.
static boolean	isSinglePomReactorAllowed(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project) Indicates whether or not the Smart Reactor should allow a reactor containing a single POM-packaging project.

Methods inherited from class java.lang.Object

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

Field Detail

PROP_DISABLED

public static final String PROP_DISABLED

See Also:

Constant Field Values

DEFAULT_DISABLED

public static final boolean DEFAULT_DISABLED

See Also:

Constant Field Values

PROP_SINGLE_POM_REACTOR_ALLOWED

public static final String PROP_SINGLE_POM_REACTOR_ALLOWED

See Also:

Constant Field Values

DEFAULT_SINGLE_POM_REACTOR_ALLOWED

public static final boolean DEFAULT_SINGLE_POM_REACTOR_ALLOWED

See Also:

Constant Field Values

PROP_EXTERNAL_SNAPSHOTS_ALLOWED

public static final String PROP_EXTERNAL_SNAPSHOTS_ALLOWED

See Also:

Constant Field Values

DEFAULT_EXTERNAL_SNAPSHOTS_ALLOWED

public static final boolean DEFAULT_EXTERNAL_SNAPSHOTS_ALLOWED

See Also:

Constant Field Values

PROP_RELEASE

public static final String PROP_RELEASE

See Also:

Constant Field Values

DEFAULT_RELEASE

public static final boolean DEFAULT_RELEASE

See Also:

Constant Field Values

PROP_ADDSCHEMA

public static final String PROP_ADDSCHEMA

See Also:

Constant Field Values

DEFAULT_ADDSCHEMA

public static final boolean DEFAULT_ADDSCHEMA

See Also:

Constant Field Values

PROP_ALLOWTIMESTAMPEDSNAPSHOTS

public static final String PROP_ALLOWTIMESTAMPEDSNAPSHOTS

See Also:

Constant Field Values

DEFAULT_ALLOWTIMESTAMPEDSNAPSHOTS

public static final boolean DEFAULT_ALLOWTIMESTAMPEDSNAPSHOTS

See Also:

Constant Field Values

PROP_AUTOVERSIONSUBMODULES

public static final String PROP_AUTOVERSIONSUBMODULES

See Also:

Constant Field Values

DEFAULT_AUTOVERSIONSUBMODULES

public static final boolean DEFAULT_AUTOVERSIONSUBMODULES

See Also:

Constant Field Values

PROP_PROJECTVERSIONPOLICYID

public static final String PROP_PROJECTVERSIONPOLICYID

See Also:

Constant Field Values

DEFAULT_PROJECTVERSIONPOLICYID

public static final String DEFAULT_PROJECTVERSIONPOLICYID

See Also:

Constant Field Values

PROP_RELEASEVERSION

public static final String PROP_RELEASEVERSION

See Also:

Constant Field Values

PROP_TAG

public static final String PROP_TAG

See Also:

Constant Field Values

PROP_TAGBASE

public static final String PROP_TAGBASE

See Also:

Constant Field Values

PROP_TAGNAMEFORMAT

public static final String PROP_TAGNAMEFORMAT

See Also:

Constant Field Values

Method Detail

getProjectVersionPolicyId

public static String getProjectVersionPolicyId(org.apache.maven.execution.MavenSession session,
                               org.apache.maven.project.MavenProject project)

Returns the "projectVersionPolicyId" property.

Parameters:

session - the Maven session.

project - a project that may have this property set.

Returns:

never null. "default" if unset anywhere.

getReleaseVersion

public static String getReleaseVersion(org.apache.maven.execution.MavenSession session,
                       org.apache.maven.project.MavenProject project)

Returns the "releaseVersion" property.

Parameters:

session - the Maven session.

project - a project that may have this property set.

Returns:

null iff unset anywhere.

getTag

public static String getTag(org.apache.maven.execution.MavenSession session,
            org.apache.maven.project.MavenProject project)

Returns the "tag" property.

Parameters:

session - the Maven session.

project - a project that may have this property set.

Returns:

null iff unset anywhere.

getTagBase

public static String getTagBase(org.apache.maven.execution.MavenSession session,
                org.apache.maven.project.MavenProject project)

Returns the "tagBase" property.

Parameters:

session - the Maven session.

project - a project that may have this property set.

Returns:

null iff unset anywhere.

getTagNameFormat

public static String getTagNameFormat(org.apache.maven.execution.MavenSession session,
                      org.apache.maven.project.MavenProject project)

Returns the "tagNameFormat" property.

Parameters:

session - the Maven session.

project - a project that may have this property set.

Returns:

null iff unset anywhere.

isAddSchema

public static boolean isAddSchema(org.apache.maven.execution.MavenSession session,
                  org.apache.maven.project.MavenProject project)

Returns the "addSchema" property.

Parameters:

session - the Maven session.

project - a project that may have this property set.

Returns:

true if set in the session or given project, false if unset.

isAllowTimestampedSnapshots

public static boolean isAllowTimestampedSnapshots(org.apache.maven.execution.MavenSession session,
                                  org.apache.maven.project.MavenProject project)

Returns the "allowTimestampedSnapshots" property.

Parameters:

session - the Maven session.

project - a project that may have this property set.

Returns:

true if set in the session or given project, false if unset.

isAutoVersionSubmodules

public static boolean isAutoVersionSubmodules(org.apache.maven.execution.MavenSession session,
                              org.apache.maven.project.MavenProject project)

Returns the "autoVersionSubmodules" property.

Parameters:

session - the Maven session.

project - a project that may have this property set.

Returns:

true if set in the session or given project, false if unset.

isDisabled

public static boolean isDisabled(org.apache.maven.execution.MavenSession session,
                 org.apache.maven.project.MavenProject project)

Indicates whether or not the Smart Reactor is disabled.

Parameters:

session - the Maven session.

project - a project that may have this property set.

Returns:

true if disabled, false if enabled.

isExternalSnapshotsAllowed

public static boolean isExternalSnapshotsAllowed(org.apache.maven.execution.MavenSession session,
                                 org.apache.maven.project.MavenProject project)

Indicates whether or not the Smart Reactor should allow a release reactor containing references to any non-reactor SNAPSHOT artifacts.

Parameters:

session - the Maven session.

project - a project that may have this property set.

Returns:

true if allowed, false if prohibited.

isRelease

public static boolean isRelease(org.apache.maven.execution.MavenSession session,
                org.apache.maven.project.MavenProject project)

Indicates whether or not a release was requested.

Parameters:

session - the Maven session.

project - a project that may have this property set.

Returns:

true if a release was requested, false otherwise.

isSinglePomReactorAllowed

public static boolean isSinglePomReactorAllowed(org.apache.maven.execution.MavenSession session,
                                org.apache.maven.project.MavenProject project)

Indicates whether or not the Smart Reactor should allow a reactor containing a single POM-packaging project.

Parameters:

session - the Maven session.

project - a project that may have this property set.

Returns:

true if allowed, false if prohibited.