Class MavenPropertiesImporter

java.lang.Object

com.igormaznitsa.jcp.maven.MavenPropertiesImporter

All Implemented Interfaces:

SpecialVariableProcessor

public class MavenPropertiesImporter
extends Object
implements SpecialVariableProcessor

The class imports some properties from the maven which can be accessible from preprocessed sources as global variables

Author:

Igor Maznitsa (igor.maznitsa@igormaznitsa.com)

Constructor Summary

Constructors

Constructor	Description
MavenPropertiesImporter(PreprocessorContext context, org.apache.maven.project.MavenProject project, boolean logAddedProperties)

Method Summary

Modifier and Type	Method	Description
Value	getVariable(String varName, PreprocessorContext context)	Get the value for the variable
String[]	getVariableNames()	Get all variable names allowed by the processor as an array, all names must be in lower case
void	setVariable(String varName, Value value, PreprocessorContext context)	Set a value to the variable

Methods inherited from class Object

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

Constructor Details

MavenPropertiesImporter

public MavenPropertiesImporter(PreprocessorContext context,
 org.apache.maven.project.MavenProject project,
 boolean logAddedProperties)

Method Details

getVariableNames

@MustNotContainNull
public String[] getVariableNames()

Description copied from interface: SpecialVariableProcessor

Get all variable names allowed by the processor as an array, all names must be in lower case

Specified by:

getVariableNames in interface SpecialVariableProcessor

Returns:

allowed variable names as a String array

getVariable

public Value getVariable(String varName,
 PreprocessorContext context)

Description copied from interface: SpecialVariableProcessor

Get the value for the variable

Specified by:

getVariable in interface SpecialVariableProcessor

Parameters:

varName - the variable name, must not be null

context - the preprocessor context, it can be null

Returns:

the value, it must not return null because it will notified preprocessor that it supports the variable

setVariable

public void setVariable(String varName,
 Value value,
 PreprocessorContext context)

Description copied from interface: SpecialVariableProcessor

Set a value to the variable

Specified by:

setVariable in interface SpecialVariableProcessor

Parameters:

varName - the variable name, must not be null

value - the value to be set to the variable, must not be null

context - the preprocessor context, it can be null