net.flexmojos.oss.plugin

Class AbstractMavenMojo

java.lang.Object

net.flexmojos.oss.plugin.AbstractMavenMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractFlexCompilerMojo, AbstractOptimizerMojo, CopyMojo, CoverageReportMojo, Font2SwfMojo, HtmlWrapperMojo, PackageAirMojo, TestRunMojo, TrusterMojo

public abstract class AbstractMavenMojo
extends Object
implements org.apache.maven.plugin.Mojo, Cacheable, org.apache.maven.plugin.ContextEnabled

Field Summary

Fields

Modifier and Type	Field and Description
static String	AIR_GLOBAL
static String	AIR_GROUP_ID
protected String	airVersion Adobe AIR version
protected org.codehaus.plexus.archiver.manager.ArchiverManager	archiverManager
protected Map<String,Object>	cache
protected File	configDirectory The maven configuration directory
static DateFormat	DATE_FORMAT
static String[]	DEFAULT_RSL_URLS
static String	DEFAULT_RUNTIME_LOCALE_OUTPUT_PATH
static String	FLASH_GROUP_ID
protected String	flashVersion Adobe Flash version
protected boolean	fullSynchronization When false (faster) Flexmojos will compiler modules and resource bundles using multiple threads (One per SWF).
protected org.hamcrest.Matcher<? extends org.apache.maven.artifact.Artifact>	GLOBAL_MATCHER
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository Local repository to be used by the plugin to resolve dependencies.
protected String	packaging
static String	PLAYER_GLOBAL
protected List<org.apache.maven.artifact.Artifact>	pluginArtifacts
protected org.apache.maven.project.MavenProject	project The maven project.
protected org.apache.maven.project.MavenProjectHelper	projectHelper
protected boolean	quick Quick compile mode.
protected List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteRepositories List of remote repositories to be used by the plugin to resolve dependencies.
protected org.apache.maven.repository.RepositorySystem	repositorySystem
protected List<org.apache.maven.model.Resource>	resources The maven resources
static org.mockito.stubbing.Answer<Object>	RETURNS_NULL
protected org.apache.maven.execution.MavenSession	session The Maven Session Object
protected boolean	skip Skips flexmojos goal execution
static String	TARGET_DIRECTORY
protected File	targetDirectory

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractMavenMojo()

Method Summary

Modifier and Type	Method and Description
protected List<org.apache.maven.model.FileSet>	as3ClassesFileSet(File... files)
protected void	checkResult(Result result)
protected File	createSwfDescriptor(File swf)
void	execute()
protected List<String>	filterClasses(List<org.apache.maven.model.FileSet> classesPattern, File[] directories)
protected Collection<File>	filterFiles(List<org.apache.maven.model.FileSet> patterns, List<File> directories)
abstract void	fmExecute()
org.apache.maven.artifact.Artifact	getAirGlobal()
String	getAirTarget()
String	getAirVersion()
protected File	getBasedir()
File	getBuildDirectory()
Map<String,Object>	getCache()
protected org.apache.maven.artifact.Artifact	getCompilerArtifact()
String	getCompilerGroupId()
String	getCompilerVersion()
Set<org.apache.maven.artifact.Artifact>	getDependencies()
protected Set<org.apache.maven.artifact.Artifact>	getDependencies(org.hamcrest.Matcher<? extends org.apache.maven.artifact.Artifact>... matchers)
protected org.apache.maven.artifact.Artifact	getDependency(org.hamcrest.Matcher<? extends org.apache.maven.artifact.Artifact>... matchers)
String	getFdkGroupId()
org.apache.maven.artifact.Artifact	getFlashGlobal()
String	getFlashVersion()
protected org.apache.maven.artifact.Artifact	getFrameworkArtifact()
String	getFrameworkArtifactVersion(String groupId, String artifactId)
protected org.apache.maven.artifact.Artifact	getFrameworkConfig()
String	getFrameworkGroupId()
String	getFrameworkVersion()
<E> E	getFromPluginContext(String key)
protected org.apache.maven.artifact.Artifact	getGlobalArtifact()
boolean	getIsAirProject()
boolean	getIsFlashProject()
org.apache.maven.plugin.logging.Log	getLog()
flex2.compiler.Logger	getMavenLogger()
flex2.compiler.common.SinglePathResolver	getMavenPathResolver()
File	getOutputDirectory()
Map<Object,Object>	getPluginContext()
protected List<File>	getResourcesTargetDirectories()
org.apache.maven.execution.MavenSession	getSession()
File	getTargetDirectory()
File	getUnpackedArtifact(File destDir, String groupId, String artifactId, String version, String classifier, String type)
File	getUnpackedArtifact(String groupId, String artifactId, String version, String classifier, String type)
protected File	getUnpackedFrameworkConfig()
protected org.hamcrest.Matcher<? extends org.apache.maven.artifact.Artifact>	initGlobalMatcher()
boolean	isSkip()
<E> void	putPluginContext(String key, E value)
org.apache.maven.artifact.Artifact	resolve(String groupId, String artifactId, String version, String classifier, String type)
protected org.codehaus.plexus.util.DirectoryScanner	scan(org.apache.maven.model.FileSet pattern)
protected org.codehaus.plexus.util.DirectoryScanner	scan(org.apache.maven.model.PatternSet pattern, File directory)
protected org.codehaus.plexus.util.DirectoryScanner	scan(org.apache.maven.model.Resource resource)
void	setArchiverManager(org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager)
void	setLog(org.apache.maven.plugin.logging.Log log)
void	setPluginContext(Map pluginContext)
protected String	toClass(String filename)
void	wait(Collection<Result> results)
protected void	wait(Result... results)

Methods inherited from class java.lang.Object

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

Field Detail

DATE_FORMAT

public static final DateFormat DATE_FORMAT

DEFAULT_RSL_URLS

public static final String[] DEFAULT_RSL_URLS

DEFAULT_RUNTIME_LOCALE_OUTPUT_PATH

public static final String DEFAULT_RUNTIME_LOCALE_OUTPUT_PATH

See Also:

Constant Field Values

AIR_GROUP_ID

public static final String AIR_GROUP_ID

See Also:

Constant Field Values

FLASH_GROUP_ID

public static final String FLASH_GROUP_ID

See Also:

Constant Field Values

AIR_GLOBAL

public static final String AIR_GLOBAL

See Also:

Constant Field Values

PLAYER_GLOBAL

public static final String PLAYER_GLOBAL

See Also:

Constant Field Values

RETURNS_NULL

public static final org.mockito.stubbing.Answer<Object> RETURNS_NULL

TARGET_DIRECTORY

public static final String TARGET_DIRECTORY

See Also:

Constant Field Values

archiverManager

protected org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager

cache

protected Map<String,Object> cache

configDirectory

protected File configDirectory

The maven configuration directory

fullSynchronization

protected boolean fullSynchronization

When false (faster) Flexmojos will compiler modules and resource bundles using multiple threads (One per SWF). If true, Thread.join() will be invoked to make the execution synchronous (sequential).

flashVersion

protected String flashVersion

Adobe Flash version

airVersion

protected String airVersion

Adobe AIR version

GLOBAL_MATCHER

protected final org.hamcrest.Matcher<? extends org.apache.maven.artifact.Artifact> GLOBAL_MATCHER

localRepository

protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

Local repository to be used by the plugin to resolve dependencies.

packaging

protected String packaging

pluginArtifacts

protected List<org.apache.maven.artifact.Artifact> pluginArtifacts

project

protected org.apache.maven.project.MavenProject project

The maven project.

projectHelper

protected org.apache.maven.project.MavenProjectHelper projectHelper

quick

protected boolean quick

Quick compile mode. When true, Flexmojos will check if the latest artifact available at maven repository for this project is newer then sources. If so, wont recompile.

remoteRepositories

protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories

List of remote repositories to be used by the plugin to resolve dependencies.

repositorySystem

protected org.apache.maven.repository.RepositorySystem repositorySystem

resources

protected List<org.apache.maven.model.Resource> resources

The maven resources

session

protected org.apache.maven.execution.MavenSession session

The Maven Session Object

skip

protected boolean skip

Skips flexmojos goal execution

targetDirectory

protected File targetDirectory

Constructor Detail

AbstractMavenMojo

public AbstractMavenMojo()

Method Detail

as3ClassesFileSet

protected List<org.apache.maven.model.FileSet> as3ClassesFileSet(File... files)

checkResult

protected void checkResult(Result result)
                    throws org.apache.maven.plugin.MojoFailureException,
                           org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

createSwfDescriptor

protected File createSwfDescriptor(File swf)

filterClasses

protected List<String> filterClasses(List<org.apache.maven.model.FileSet> classesPattern,
                                     File[] directories)

filterFiles

protected Collection<File> filterFiles(List<org.apache.maven.model.FileSet> patterns,
                                       List<File> directories)

getAirTarget

public String getAirTarget()

getBasedir

protected File getBasedir()

getCache

public Map<String,Object> getCache()

Specified by:

getCache in interface Cacheable

getCompilerArtifact

protected org.apache.maven.artifact.Artifact getCompilerArtifact()

getFrameworkArtifact

protected org.apache.maven.artifact.Artifact getFrameworkArtifact()

getFdkGroupId

public String getFdkGroupId()

getCompilerGroupId

public String getCompilerGroupId()

getFrameworkGroupId

public String getFrameworkGroupId()

getCompilerVersion

public String getCompilerVersion()

getFrameworkArtifactVersion

public String getFrameworkArtifactVersion(String groupId,
                                          String artifactId)

getDependencies

public Set<org.apache.maven.artifact.Artifact> getDependencies()

getDependencies

protected Set<org.apache.maven.artifact.Artifact> getDependencies(org.hamcrest.Matcher<? extends org.apache.maven.artifact.Artifact>... matchers)

getDependency

protected org.apache.maven.artifact.Artifact getDependency(org.hamcrest.Matcher<? extends org.apache.maven.artifact.Artifact>... matchers)

getFrameworkConfig

protected org.apache.maven.artifact.Artifact getFrameworkConfig()

getFrameworkVersion

public String getFrameworkVersion()

getFromPluginContext

public <E> E getFromPluginContext(String key)

getGlobalArtifact

protected org.apache.maven.artifact.Artifact getGlobalArtifact()

getAirGlobal

public org.apache.maven.artifact.Artifact getAirGlobal()

getIsAirProject

public boolean getIsAirProject()

getAirVersion

public String getAirVersion()

getFlashGlobal

public org.apache.maven.artifact.Artifact getFlashGlobal()

getIsFlashProject

public boolean getIsFlashProject()

getFlashVersion

public String getFlashVersion()

getLog

public org.apache.maven.plugin.logging.Log getLog()

Specified by:

getLog in interface org.apache.maven.plugin.Mojo

getMavenLogger

public flex2.compiler.Logger getMavenLogger()

getMavenPathResolver

public flex2.compiler.common.SinglePathResolver getMavenPathResolver()

getOutputDirectory

public File getOutputDirectory()

getBuildDirectory

public File getBuildDirectory()

getPluginContext

public Map<Object,Object> getPluginContext()

Specified by:

getPluginContext in interface org.apache.maven.plugin.ContextEnabled

See Also:

ContextEnabled.getPluginContext()

getResourcesTargetDirectories

protected List<File> getResourcesTargetDirectories()

getSession

public org.apache.maven.execution.MavenSession getSession()

getTargetDirectory

public File getTargetDirectory()

getUnpackedArtifact

public File getUnpackedArtifact(String groupId,
                                String artifactId,
                                String version,
                                String classifier,
                                String type)

getUnpackedArtifact

public File getUnpackedArtifact(File destDir,
                                String groupId,
                                String artifactId,
                                String version,
                                String classifier,
                                String type)

getUnpackedFrameworkConfig

protected File getUnpackedFrameworkConfig()

initGlobalMatcher

protected org.hamcrest.Matcher<? extends org.apache.maven.artifact.Artifact> initGlobalMatcher()

isSkip

public boolean isSkip()

putPluginContext

public <E> void putPluginContext(String key,
                                 E value)

resolve

public org.apache.maven.artifact.Artifact resolve(String groupId,
                                                  String artifactId,
                                                  String version,
                                                  String classifier,
                                                  String type)
                                           throws RuntimeMavenResolutionException

Throws:

RuntimeMavenResolutionException

scan

protected org.codehaus.plexus.util.DirectoryScanner scan(org.apache.maven.model.FileSet pattern)

scan

protected org.codehaus.plexus.util.DirectoryScanner scan(org.apache.maven.model.PatternSet pattern,
                                                         File directory)

scan

protected org.codehaus.plexus.util.DirectoryScanner scan(org.apache.maven.model.Resource resource)

setArchiverManager

public void setArchiverManager(org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager)

setLog

public void setLog(org.apache.maven.plugin.logging.Log log)

Specified by:

setLog in interface org.apache.maven.plugin.Mojo

setPluginContext

public void setPluginContext(Map pluginContext)

Specified by:

setPluginContext in interface org.apache.maven.plugin.ContextEnabled

See Also:

ContextEnabled.setPluginContext(java.util.Map)

toClass

protected String toClass(String filename)

wait

public void wait(Collection<Result> results)
          throws org.apache.maven.plugin.MojoFailureException,
                 org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

wait

protected void wait(Result... results)
             throws org.apache.maven.plugin.MojoFailureException,
                    org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

fmExecute

public abstract void fmExecute()
                        throws org.apache.maven.plugin.MojoExecutionException,
                               org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException