Package com.ruleoftech.markdown.page.generator.plugin

Class MdPageGeneratorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.ruleoftech.markdown.page.generator.plugin.MdPageGeneratorMojo

All Implemented Interfaces:

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

@Mojo(name="generate",
      threadSafe=true)
public class MdPageGeneratorMojo
extends org.apache.maven.plugin.AbstractMojo

Creates a static html from markdown files.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	addDefaultExcludes	By default files like .gitignore, .cvsignore etc.
protected List<String>	buildFilters
protected List<String>	filters
protected org.apache.maven.shared.filtering.MavenResourcesFiltering	mavenResourcesFiltering
protected List<String>	nonFilteredFileExtensions
protected org.apache.maven.execution.MavenSession	session	The maven session.
protected boolean	useBuildFilters

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

ROLE

Constructor Summary

Constructors

Constructor	Description
MdPageGeneratorMojo()

Method Summary

Modifier and Type	Method	Description
void	contextualize(org.codehaus.plexus.context.Context context)
void	execute()	Execute the maven plugin.
protected void	executeUserFilterComponents(org.apache.maven.shared.filtering.MavenResourcesExecution mavenResourcesExecution)
protected List<String>	getCombinedFiltersList()
String	getCopyDirectories()
String	getInputDirectory()
String[]	getInputFileExtensions()
String	getOutputDirectory()
String[]	getOutputFileExtensions()
void	setCopyDirectories(String copyDirectories)
void	setInputDirectory(String inputDirectory)
void	setOutputDirectory(String outputDirectory)

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

session

@Component
protected org.apache.maven.execution.MavenSession session

The maven session.

mavenResourcesFiltering

@Component(role=org.apache.maven.shared.filtering.MavenResourcesFiltering.class,
           hint="default")
protected org.apache.maven.shared.filtering.MavenResourcesFiltering mavenResourcesFiltering

nonFilteredFileExtensions

@Parameter
protected List<String> nonFilteredFileExtensions

addDefaultExcludes

@Parameter(defaultValue="true")
protected boolean addDefaultExcludes

By default files like .gitignore, .cvsignore etc. are excluded which means they will not being copied. If you need them for a particular reason you can do that by settings this to false. This means all files like the following will be copied.

• Misc: **/*~, **/#*#, **/.#*, **/%*%, **/._*
• CVS: **/CVS, **/CVS/**, **/.cvsignore
• RCS: **/RCS, **/RCS/**
• SCCS: **/SCCS, **/SCCS/**
• VSSercer: **/vssver.scc
• MKS: **/project.pj
• SVN: **/.svn, **/.svn/**
• GNU: **/.arch-ids, **/.arch-ids/**
• Bazaar: **/.bzr, **/.bzr/**
• SurroundSCM: **/.MySCMServerInfo
• Mac: **/.DS_Store
• Serena Dimension: **/.metadata, **/.metadata/**
• Mercurial: **/.hg, **/.hg/**
• GIT: **/.git, **/.gitignore, **/.gitattributes, **/.git/**
• Bitkeeper: **/BitKeeper, **/BitKeeper/**, **/ChangeSet, **/ChangeSet/**
• Darcs: **/_darcs, **/_darcs/**, **/.darcsrepo, **/.darcsrepo/****/-darcs-backup*, **/.darcs-temp-mail

Since:

3.0.0

filters

@Parameter
protected List<String> filters

useBuildFilters

@Parameter(defaultValue="true")
protected boolean useBuildFilters

buildFilters

@Parameter(defaultValue="${project.build.filters}",
           readonly=true)
protected List<String> buildFilters

Constructor Detail

MdPageGeneratorMojo

public MdPageGeneratorMojo()

Method Detail

getInputDirectory

public String getInputDirectory()

setInputDirectory

public void setInputDirectory(String inputDirectory)

getOutputDirectory

public String getOutputDirectory()

setOutputDirectory

public void setOutputDirectory(String outputDirectory)

getCopyDirectories

public String getCopyDirectories()

setCopyDirectories

public void setCopyDirectories(String copyDirectories)

execute

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

Execute the maven plugin.

Throws:

org.apache.maven.plugin.MojoExecutionException - Something went wrong

getInputFileExtensions

public String[] getInputFileExtensions()

getOutputFileExtensions

public String[] getOutputFileExtensions()

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException

Throws:

org.codehaus.plexus.context.ContextException

executeUserFilterComponents

protected void executeUserFilterComponents(org.apache.maven.shared.filtering.MavenResourcesExecution mavenResourcesExecution)
                                    throws org.apache.maven.plugin.MojoExecutionException,
                                           org.apache.maven.shared.filtering.MavenFilteringException

Parameters:

mavenResourcesExecution - MavenResourcesExecution

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of wrong lookup.

org.apache.maven.shared.filtering.MavenFilteringException - in case of failure.

Since:

2.5

getCombinedFiltersList

protected List<String> getCombinedFiltersList()

Returns:

The combined filters.