Class CommandLineMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.glassfish.spec.maven.CommandLineMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="cli",
      requiresProject=true,
      defaultPhase=VALIDATE)
public final class CommandLineMojo
extends org.apache.maven.plugin.AbstractMojo

Maven Goal to run spec verifications from the command line.

Field Summary

Fields

Modifier and Type	Field	Description
private String	apiJar	Path to the API jar file.
private String	apiPackage	API package.
private static Console	cons	The system console.
private boolean	help	Show the usage.
private String	implBuild	Implementation build.
private String	implJar	Path to the Impl jar file.
private String	implNamespace	Implementation namespace.
private String	implVersion	Implementation version.
private boolean	isFinal	Is it a final specification?.
private String	jarType	Is it an API jar?.
private String	newImplVersion	New implementation version.
private String	newSpecVersion	New spec version.
private File	properties	Property file.
private String	specBuild	Spec build.
private String	specImplVersion	Spec implementation version.
private String	specMode	Mode.
private String	specVersion	Spec version.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
CommandLineMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()
private static void	fail(String msg)	Print error and exit.
private static void	printParam(String arg, String desc)	Print a given parameter to the standard output.
private static String	prompt(String msg)	Prompt with the string and return the user's input.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

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

Field Details

isFinal

@Parameter(property="isFinal",
           defaultValue="false")
private boolean isFinal

Is it a final specification?.

jarType

@Parameter(property="isApi",
           defaultValue="true")
private String jarType

Is it an API jar?.

apiJar

@Parameter(property="apijar")
private String apiJar

Path to the API jar file.

implJar

@Parameter(property="impljar")
private String implJar

Path to the Impl jar file.

implNamespace

@Parameter(property="implnamespace")
private String implNamespace

Implementation namespace.

specMode

@Parameter(property="specMode",
           defaultValue="jakarta")
private String specMode

Mode. Allowed values are "javaee", "jakarta"

apiPackage

@Parameter(property="apipackage")
private String apiPackage

API package.

specVersion

@Parameter(property="specversion")
private String specVersion

Spec version.

specImplVersion

@Parameter(property="specimplversion")
private String specImplVersion

Spec implementation version.

implVersion

@Parameter(property="implversion")
private String implVersion

Implementation version.

newImplVersion

@Parameter(property="newimplversion")
private String newImplVersion

New implementation version.

newSpecVersion

@Parameter(property="newspecversion")
private String newSpecVersion

New spec version.

specBuild

@Parameter(property="specbuild")
private String specBuild

Spec build.

implBuild

@Parameter(property="implbuild")
private String implBuild

Implementation build.

properties

@Parameter(property="properties")
private File properties

Property file.

help

@Parameter(property="help",
           defaultValue="true")
private boolean help

Show the usage.

cons

private static Console cons

The system console.

Constructor Details

CommandLineMojo

public CommandLineMojo()

Method Details

prompt

private static String prompt(String msg)

Prompt with the string and return the user's input.

Parameters:

msg - the prompt message

Returns:

the user input

fail

private static void fail(String msg)

Print error and exit.

Parameters:

msg - the error message

printParam

private static void printParam(String arg,
 String desc)

Print a given parameter to the standard output.

Parameters:

arg - the parameter

desc - the description

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException