top.infra.maven.extension.shared

Enum MavenOption

java.lang.Object

java.lang.Enum<MavenOption>

top.infra.maven.extension.shared.MavenOption

All Implemented Interfaces:

Serializable, Comparable<MavenOption>, CiOption

public enum MavenOption
extends Enum<MavenOption>
implements CiOption

Maven official (include official plugin) options.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARGLINE maven-failsafe-plugin and maven-surefire-plugin's configuration argLine.
ENFORCER_SKIP
GENERATEREPORTS See: "https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html".
JIRA_PASSWORD
JIRA_PROJECTKEY
JIRA_USER
LINKXREF
MAVEN_CLEAN_SKIP
MAVEN_COMPILER_ENCODING
MAVEN_INSTALL_SKIP
MAVEN_JAVADOC_SKIP
MAVEN_SITE_DEPLOY_SKIP
MAVEN_SITE_SKIP See: "https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html".
MAVEN_SOURCE_SKIP
MAVEN_TEST_FAILURE_IGNORE
MAVEN_TEST_SKIP Deprecated.
PMD_SKIP
PROJECT_BUILD_SOURCEENCODING Deprecated.
PROJECT_REPORTING_OUTPUTENCODING Deprecated.
SKIPITS Since skipTests is also supported by the Surefire Plugin, this will have the effect of not running any tests.
SKIPTESTS Keep test-compile but do not run tests.
SONAR_BUILDBREAKER_SKIP
SPOTBUGS_SKIP

Method Summary

Modifier and Type	Method and Description
Optional<String>	getDefaultValue()
String	getPropertyName()
static MavenOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static MavenOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface top.infra.maven.CiOption

calculateValue, findInProperties, getEnvVariableName, getSystemPropertyName, getValue, name, setProperties

Enum Constant Detail

ARGLINE

public static final MavenOption ARGLINE

maven-failsafe-plugin and maven-surefire-plugin's configuration argLine.

ENFORCER_SKIP

public static final MavenOption ENFORCER_SKIP

MAVEN_CLEAN_SKIP

public static final MavenOption MAVEN_CLEAN_SKIP

MAVEN_COMPILER_ENCODING

public static final MavenOption MAVEN_COMPILER_ENCODING

MAVEN_INSTALL_SKIP

public static final MavenOption MAVEN_INSTALL_SKIP

MAVEN_JAVADOC_SKIP

public static final MavenOption MAVEN_JAVADOC_SKIP

GENERATEREPORTS

public static final MavenOption GENERATEREPORTS

See: "https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html".

Convenience parameter that allows you to disable report generation.

JIRA_PROJECTKEY

public static final MavenOption JIRA_PROJECTKEY

JIRA_USER

public static final MavenOption JIRA_USER

JIRA_PASSWORD

public static final MavenOption JIRA_PASSWORD

LINKXREF

public static final MavenOption LINKXREF

MAVEN_SITE_SKIP

public static final MavenOption MAVEN_SITE_SKIP

See: "https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html".

Set this to 'true' to skip site generation and staging.

MAVEN_SITE_DEPLOY_SKIP

public static final MavenOption MAVEN_SITE_DEPLOY_SKIP

MAVEN_SOURCE_SKIP

public static final MavenOption MAVEN_SOURCE_SKIP

MAVEN_TEST_FAILURE_IGNORE

public static final MavenOption MAVEN_TEST_FAILURE_IGNORE

MAVEN_TEST_SKIP

@Deprecated
public static final MavenOption MAVEN_TEST_SKIP

Deprecated.

Skip test-compile and skipTests and skipITs.

maven.test.skip property skips compiling the tests. maven.test.skip is honored by Surefire, Failsafe and the Compiler Plugin.

PMD_SKIP

public static final MavenOption PMD_SKIP

PROJECT_BUILD_SOURCEENCODING

@Deprecated
public static final MavenOption PROJECT_BUILD_SOURCEENCODING

Deprecated.

PROJECT_REPORTING_OUTPUTENCODING

@Deprecated
public static final MavenOption PROJECT_REPORTING_OUTPUTENCODING

Deprecated.

SKIPITS

public static final MavenOption SKIPITS

Since skipTests is also supported by the Surefire Plugin, this will have the effect of not running any tests. If, instead, you want to skip only the integration tests being run by the Failsafe Plugin, you would use the skipITs property instead. see: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/skipping-tests.html

SKIPTESTS

public static final MavenOption SKIPTESTS

Keep test-compile but do not run tests.

see: https://maven.apache.org/surefire/maven-surefire-plugin/examples/skipping-tests.html

SONAR_BUILDBREAKER_SKIP

public static final MavenOption SONAR_BUILDBREAKER_SKIP

SPOTBUGS_SKIP

public static final MavenOption SPOTBUGS_SKIP

Method Detail

values

public static MavenOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MavenOption c : MavenOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MavenOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDefaultValue

public Optional<String> getDefaultValue()

Specified by:

getDefaultValue in interface CiOption

getPropertyName

public String getPropertyName()

Specified by:

getPropertyName in interface CiOption