net.sourceforge.javadpkg.plugin

Class ReplacementsMaven

java.lang.Object

net.sourceforge.javadpkg.plugin.ReplacementsMaven

All Implemented Interfaces:

Replacements

public class ReplacementsMaven
extends Object
implements Replacements

The replacements which are based on the plug-in properties, the MavenProject, the environment variables (see System.getenv()) and the system properties (see System.getProperties()).

If the value of a variable is requested by calling the getValue(String) method the lookup of the variable is performed the following way:

• Does the variable exist in the plug-in properties? If yes, return the value.
• Does the variable exist in the MavenProject properties (see MavenProject.getProperties())? If yes, return the value.
• Does the variable - removing the leading "project" / "project." - exist in the MavenProject as property? If yes, return the value.
• Does the variable - removing the leading "env" / "env." - exist as a environment variable? If yes, return the value.
• Does the variable exist as a system property? If yes, return the value.
• Otherwise return null.

Version:

1.0, 04.05.2016 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
ReplacementsMaven(Map<Object,Object> pluginProperties, org.apache.maven.project.MavenProject project, org.apache.maven.settings.Settings settings, Map<String,String> environment, Map<Object,Object> systemProperties) Creates replacements.

Method Summary

Modifier and Type	Method and Description
String	getValue(String name) Returns the value for the variable with the specified name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplacementsMaven

public ReplacementsMaven(Map<Object,Object> pluginProperties,
                         org.apache.maven.project.MavenProject project,
                         org.apache.maven.settings.Settings settings,
                         Map<String,String> environment,
                         Map<Object,Object> systemProperties)

Creates replacements.

Parameters:

pluginProperties - The properties of the plug-in configuration.

project - The Maven project.

settings - The settings of the local Maven installation.

environment - The environment variables.

systemProperties - The system properties.

Throws:

IllegalArgumentException - If any of the parameters are null.

Method Detail

getValue

public String getValue(String name)
                throws ReplacementException

Description copied from interface: Replacements

Returns the value for the variable with the specified name.

Specified by:

getValue in interface Replacements

Parameters:

name - The name.

Returns:

The value or null, if the variable is unknown.

Throws:

ReplacementException - If an error occurs while determine the value.