Package de.gematik.combine

Class CombineMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

de.gematik.combine.CombineMojo

All Implemented Interfaces:

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

@Mojo(name="prepare-combine",
      defaultPhase=GENERATE_TEST_SOURCES)
public class CombineMojo
extends org.apache.maven.plugin.AbstractMojo

Plugin for filling empty gherkin tables with generated combinations

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CombineMojo.ErrorType

Field Summary

Fields

Modifier and Type	Field	Description
static String	EMPTY_EXAMPLES_TABLE_TAG
static String	MINIMAL_TABLE_ERROR_HEADER
static String	TEST_RESOURCES_DIR
static String	WARN_MESSAGE
static String	WIP_TAG

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

ROLE

Constructor Summary

Constructors

Constructor	Description
CombineMojo(FileProcessor replacer)

Method Summary

Modifier and Type	Method	Description
static Collection<File>	allFiles(String dir, String ending)
static void	appendError(String error, CombineMojo.ErrorType type)
static void	copyFiles(String from, String to, String ending)
void	execute()
void	execute(CombineConfiguration config)
static CombineMojo	getInstance()
static List<String>	getMinimalTableErrorLog()
static org.apache.maven.plugin.logging.Log	getPluginLog()
static List<String>	getTableSizeErrorLog()
static void	resetError()
void	setBreakIfMinimalTableError(boolean breakIfMinimalTableError)	The plugin will throw exception if minimal table could not generate valid row for at least one value
void	setBreakIfTableToSmall(boolean breakIfTableToSmall)	The plugin will throw exception it was not able to add at least one row
void	setCombineItemsFile(String combineItemsFile)	Path to file that contains the values to combine
void	setDefaultExamplesTags(List<String> defaultExamplesTags)	List of tags that are added to each processed examples table
void	setEmptyExamplesTags(List<String> emptyExamplesTags)	The plugin will add these tags to all examples tables where it was not able to add at least one row
void	setEnding(String ending)	The specific ending of the templates
void	setFilterConfiguration(FilterConfiguration filterConfiguration)	filterConfiguration
static void	setInstance(CombineMojo instance)
void	setMinTableSize(int minTableSize)	The plugin will throw exception it was not able to add at least one row
void	setOutputDir(String outputDir)	Path to the directory where the rendered templates got stored
void	setPluginTagCategory(String pluginTagCategory)	Prefix that is added to all plugin specific tags in the feature file to categorize them under in the report
void	setSkipTags(List<String> skipTags)	List of tags that are skipped by this plugin
void	setTemplateDir(String templateDir)	Path to the directory of the templates
static File	stripEnding(File file, String ending)

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_EXAMPLES_TABLE_TAG

public static final String EMPTY_EXAMPLES_TABLE_TAG

See Also:

Constant Field Values

WIP_TAG

public static final String WIP_TAG

See Also:

Constant Field Values

TEST_RESOURCES_DIR

public static final String TEST_RESOURCES_DIR

See Also:

Constant Field Values

WARN_MESSAGE

public static final String WARN_MESSAGE

See Also:

Constant Field Values

MINIMAL_TABLE_ERROR_HEADER

public static final String MINIMAL_TABLE_ERROR_HEADER

See Also:

Constant Field Values

Constructor Detail

CombineMojo

@Inject
public CombineMojo(FileProcessor replacer)

Method Detail

execute

public void execute()

execute

public void execute(CombineConfiguration config)
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

copyFiles

public static void copyFiles(String from,
                             String to,
                             String ending)

stripEnding

public static File stripEnding(File file,
                               String ending)

allFiles

public static Collection<File> allFiles(String dir,
                                        String ending)

getPluginLog

public static org.apache.maven.plugin.logging.Log getPluginLog()

appendError

public static void appendError(String error,
                               CombineMojo.ErrorType type)

resetError

public static void resetError()

setOutputDir

public void setOutputDir(String outputDir)

Path to the directory where the rendered templates got stored

setTemplateDir

public void setTemplateDir(String templateDir)

Path to the directory of the templates

setEnding

public void setEnding(String ending)

The specific ending of the templates

setEmptyExamplesTags

public void setEmptyExamplesTags(List<String> emptyExamplesTags)

The plugin will add these tags to all examples tables where it was not able to add at least one row

setBreakIfTableToSmall

public void setBreakIfTableToSmall(boolean breakIfTableToSmall)

The plugin will throw exception it was not able to add at least one row

setMinTableSize

public void setMinTableSize(int minTableSize)

The plugin will throw exception it was not able to add at least one row

setBreakIfMinimalTableError

public void setBreakIfMinimalTableError(boolean breakIfMinimalTableError)

The plugin will throw exception if minimal table could not generate valid row for at least one value

setPluginTagCategory

public void setPluginTagCategory(String pluginTagCategory)

Prefix that is added to all plugin specific tags in the feature file to categorize them under in the report

setDefaultExamplesTags

public void setDefaultExamplesTags(List<String> defaultExamplesTags)

List of tags that are added to each processed examples table

setSkipTags

public void setSkipTags(List<String> skipTags)

List of tags that are skipped by this plugin

setFilterConfiguration

public void setFilterConfiguration(FilterConfiguration filterConfiguration)

filterConfiguration

getInstance

public static CombineMojo getInstance()

setInstance

public static void setInstance(CombineMojo instance)

setCombineItemsFile

public void setCombineItemsFile(String combineItemsFile)

Path to file that contains the values to combine

getTableSizeErrorLog

public static List<String> getTableSizeErrorLog()

getMinimalTableErrorLog

public static List<String> getMinimalTableErrorLog()