Package org.apache.maven.cling.invoker.mvnup.goals

package org.apache.maven.cling.invoker.mvnup.goals

Maven Upgrade Tool Goals and Strategies.

This package contains the implementation of the Maven upgrade tool (mvnup) that helps upgrade Maven projects to be compatible with Maven 4. The tool is organized around a goal-based architecture with pluggable upgrade strategies.

Architecture Overview

Goals

• Check - Analyzes projects and reports needed upgrades
• Apply - Applies upgrades to project files
• Help - Displays usage information

Upgrade Strategies

The tool uses a strategy pattern to handle different types of upgrades:

• ModelUpgradeStrategy - Upgrades POM model versions (4.0.0 → 4.1.0)
• PluginUpgradeStrategy - Upgrades plugin versions for Maven 4 compatibility
• InferenceStrategy - Applies Maven 4.1.0+ inference optimizations
• CompatibilityFixStrategy - Fixes Maven 4 compatibility issues

Utility Classes

• StrategyOrchestrator - Coordinates strategy execution
• PomDiscovery - Discovers POM files in multi-module projects
• JDomUtils - XML manipulation utilities

Usage Examples

Check for Available Upgrades

 mvnup check
 

Apply All Upgrades

 mvnup apply --all
 

Upgrade to Maven 4.1.0 with Inference

 mvnup apply --model 4.1.0 --infer
 

Extension Points

To add new upgrade strategies:

1. Implement UpgradeStrategy
2. Optionally extend AbstractUpgradeStrategy
3. Annotate with @Named and @Singleton
4. Use @Priority to control execution order

Since:

4.0.0

Related Packages

Package	Description
org.apache.maven.cling.invoker.mvnup	Implementation of the Maven Upgrade tool (mvnup).

Class	Description
AbstractUpgradeGoal	Base class for upgrade goals containing shared functionality.
AbstractUpgradeStrategy	Abstract base class for upgrade strategies that provides common functionality and reduces code duplication across strategy implementations.
Apply	The "apply" goal implementation.
Check	The "check" goal implementation.
CompatibilityFixStrategy	Strategy for applying Maven 4 compatibility fixes to POM files.
GAV	Represents a Maven GAV (GroupId, ArtifactId, Version) coordinate.
GAVUtils	Utility class for handling GroupId, ArtifactId, Version (GAV) operations in Maven POM files during the upgrade process.
Help	The "help" goal implementation.
InferenceStrategy	Strategy for applying Maven inference optimizations.
JDomUtils	Utility class for JDOM operations.
ModelUpgradeStrategy	Strategy for upgrading Maven model versions (e.g., 4.0.0 → 4.1.0).
ModelVersionUtils	Utility class for handling Maven model version operations during upgrades.
PluginUpgrade	Plugin upgrade configuration for Maven 4 compatibility.
PluginUpgradeStrategy	Strategy for upgrading Maven plugins to recommended versions.
PluginUpgradeStrategy.PluginUpgradeInfo	Holds plugin upgrade information for Maven 4 compatibility.
PomDiscovery	Utility class for discovering and loading POM files in a Maven project hierarchy.
StrategyOrchestrator	Orchestrates the execution of different upgrade strategies.
UpgradeConstants	Constants used throughout the Maven upgrade tools.
UpgradeConstants.Files	Common file and directory names.
UpgradeConstants.Indentation	Common indentation patterns for XML formatting.
UpgradeConstants.ModelVersions	Maven model version constants.
UpgradeConstants.Namespaces	Maven namespace constants.
UpgradeConstants.Plugins	Common Maven plugin constants.
UpgradeConstants.SchemaLocations	Schema location constants.
UpgradeConstants.XmlAttributes	XML attribute constants.
UpgradeConstants.XmlElements	Common XML element names used in Maven POMs.
UpgradeResult	Result of an upgrade strategy application.
UpgradeStrategy	Strategy interface for different types of upgrade operations.