Package com.vaadin.flow.plugin.maven

Class FlowModeAbstractMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

BuildFrontendMojo, CleanFrontendMojo, ConvertPolymerMojo, PrepareFrontendMojo

public abstract class FlowModeAbstractMojo
extends org.apache.maven.plugin.AbstractMojo
implements PluginAdapterBase

The base class of Flow Mojos in order to compute correctly the modes.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCLUDE_FROM_COMPILE_DEPS_REGEX	Additionally include compile-time-only dependencies matching the pattern.
protected Boolean	productionMode	Whether or not we are running in productionMode.

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

ROLE

Constructor Summary

Constructors

Constructor	Description
FlowModeAbstractMojo()

Method Summary

Modifier and Type	Method	Description
File	applicationProperties()
String	buildFolder()
boolean	eagerServerLoad()
File	frontendDirectory()
File	generatedTsFolder()
com.vaadin.flow.server.frontend.scanner.ClassFinder	getClassFinder()
static List<String>	getClasspathElements(org.apache.maven.project.MavenProject project)	Generates a List of ClasspathElements (Run and CompileTime) from a MavenProject.
Set<File>	getJarFiles()
boolean	isDebugEnabled()
boolean	isFrontendHotdeploy()
boolean	isJarProject()
boolean	isPrepareFrontendCacheDisabled()
File	javaResourceFolder()
File	javaSourceFolder()
void	logDebug(CharSequence debugMessage)
void	logError(CharSequence warning, Throwable e)
void	logInfo(CharSequence infoMessage)
void	logWarn(CharSequence warning)
void	logWarn(CharSequence warning, Throwable e)
boolean	nodeAutoUpdate()
URI	nodeDownloadRoot()
String	nodeVersion()
File	npmFolder()
File	openApiJsonFile()
boolean	pnpmEnable()
List<String>	postinstallPackages()
Path	projectBaseDirectory()
boolean	requireHomeNodeExec()
File	servletResourceOutputDirectory()
boolean	skipDevBundleBuild()
boolean	useGlobalPnpm()
File	webpackOutputDirectory()

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

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

execute

Methods inherited from interface com.vaadin.flow.plugin.base.PluginAdapterBase

createLookup

Field Details

INCLUDE_FROM_COMPILE_DEPS_REGEX

public static final String INCLUDE_FROM_COMPILE_DEPS_REGEX

Additionally include compile-time-only dependencies matching the pattern.

See Also:

• Constant Field Values

productionMode

@Parameter(defaultValue="${null}")
protected Boolean productionMode

Whether or not we are running in productionMode.

Constructor Details

FlowModeAbstractMojo

public FlowModeAbstractMojo()

Method Details

getClasspathElements

public static List<String> getClasspathElements(org.apache.maven.project.MavenProject project)

Generates a List of ClasspathElements (Run and CompileTime) from a MavenProject.

Parameters:

project - a given MavenProject

Returns:

List of ClasspathElements

applicationProperties

public File applicationProperties()

Specified by:

applicationProperties in interface PluginAdapterBase

eagerServerLoad

public boolean eagerServerLoad()

Specified by:

eagerServerLoad in interface PluginAdapterBase

frontendDirectory

public File frontendDirectory()

Specified by:

frontendDirectory in interface PluginAdapterBase

generatedTsFolder

public File generatedTsFolder()

Specified by:

generatedTsFolder in interface PluginAdapterBase

getClassFinder

public com.vaadin.flow.server.frontend.scanner.ClassFinder getClassFinder()

Specified by:

getClassFinder in interface PluginAdapterBase

getJarFiles

public Set<File> getJarFiles()

Specified by:

getJarFiles in interface PluginAdapterBase

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface PluginAdapterBase

javaSourceFolder

public File javaSourceFolder()

Specified by:

javaSourceFolder in interface PluginAdapterBase

javaResourceFolder

public File javaResourceFolder()

Specified by:

javaResourceFolder in interface PluginAdapterBase

logDebug

public void logDebug(CharSequence debugMessage)

Specified by:

logDebug in interface PluginAdapterBase

logInfo

public void logInfo(CharSequence infoMessage)

Specified by:

logInfo in interface PluginAdapterBase

logWarn

public void logWarn(CharSequence warning)

Specified by:

logWarn in interface PluginAdapterBase

logWarn

public void logWarn(CharSequence warning,
 Throwable e)

Specified by:

logWarn in interface PluginAdapterBase

logError

public void logError(CharSequence warning,
 Throwable e)

Specified by:

logError in interface PluginAdapterBase

nodeDownloadRoot

public URI nodeDownloadRoot()
                     throws URISyntaxException

Specified by:

nodeDownloadRoot in interface PluginAdapterBase

Throws:

URISyntaxException

nodeAutoUpdate

public boolean nodeAutoUpdate()

Specified by:

nodeAutoUpdate in interface PluginAdapterBase

nodeVersion

public String nodeVersion()

Specified by:

nodeVersion in interface PluginAdapterBase

npmFolder

public File npmFolder()

Specified by:

npmFolder in interface PluginAdapterBase

openApiJsonFile

public File openApiJsonFile()

Specified by:

openApiJsonFile in interface PluginAdapterBase

pnpmEnable

public boolean pnpmEnable()

Specified by:

pnpmEnable in interface PluginAdapterBase

useGlobalPnpm

public boolean useGlobalPnpm()

Specified by:

useGlobalPnpm in interface PluginAdapterBase

projectBaseDirectory

public Path projectBaseDirectory()

Specified by:

projectBaseDirectory in interface PluginAdapterBase

requireHomeNodeExec

public boolean requireHomeNodeExec()

Specified by:

requireHomeNodeExec in interface PluginAdapterBase

servletResourceOutputDirectory

public File servletResourceOutputDirectory()

Specified by:

servletResourceOutputDirectory in interface PluginAdapterBase

webpackOutputDirectory

public File webpackOutputDirectory()

Specified by:

webpackOutputDirectory in interface PluginAdapterBase

isJarProject

public boolean isJarProject()

Specified by:

isJarProject in interface PluginAdapterBase

buildFolder

public String buildFolder()

Specified by:

buildFolder in interface PluginAdapterBase

postinstallPackages

public List<String> postinstallPackages()

Specified by:

postinstallPackages in interface PluginAdapterBase

isFrontendHotdeploy

public boolean isFrontendHotdeploy()

Specified by:

isFrontendHotdeploy in interface PluginAdapterBase

skipDevBundleBuild

public boolean skipDevBundleBuild()

Specified by:

skipDevBundleBuild in interface PluginAdapterBase

isPrepareFrontendCacheDisabled

public boolean isPrepareFrontendCacheDisabled()

Specified by:

isPrepareFrontendCacheDisabled in interface PluginAdapterBase