com.google.code.play2.plugin

Class AbstractPlay2Mojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.google.code.play2.plugin.AbstractPlay2Mojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractAntJavaBasedPlay2Mojo, AbstractArchivingMojo, AbstractPlay2AssetsCompileMojo, AbstractPlay2EnhanceMojo, AbstractPlay2SourceGeneratorMojo, AbstractPlay2StopServerMojo

public abstract class AbstractPlay2Mojo
extends org.apache.maven.plugin.AbstractMojo

Abstract base class for Play! Mojos.

Author:

Grzegorz Slowikowski

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepo Location of the local repository.
protected String	playVersion Used to automatically select one of the "well known" Play! providers if no provider added explicitly as plugin's dependency.
protected String	pluginGroupId Plugin's groupId used for well known providers resolution
protected String	pluginVersion Plugin's version used for well known providers resolution
protected org.apache.maven.project.MavenProject	project Maven Internal: Project to interact with.
protected List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteRepos Remote repositories used by the resolver
protected org.apache.maven.repository.RepositorySystem	repositorySystem ...
protected org.apache.maven.artifact.resolver.ResolutionErrorHandler	resolutionErrorHandler ...
protected org.apache.maven.execution.MavenSession	session The current build session instance.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractPlay2Mojo()

Method Summary

Modifier and Type	Method and Description
protected BufferedReader	createBufferedFileReader(File file, String encoding)
protected BufferedWriter	createBufferedFileWriter(File file, String encoding)
protected void	createDirectory(File directory, boolean overwrite)
void	execute()
protected Play2Provider	getProvider()
protected Set<org.apache.maven.artifact.Artifact>	getResolvedArtifact(org.apache.maven.artifact.Artifact artifact, boolean transitively)
protected Set<org.apache.maven.artifact.Artifact>	getResolvedArtifact(String groupId, String artifactId, String version)
protected Set<org.apache.maven.artifact.Artifact>	getResolvedArtifact(String groupId, String artifactId, String version, boolean transitively)
protected abstract void	internalExecute()
protected boolean	isMatchingProject(org.apache.maven.project.MavenProject p, String selector)
protected String	readFileFirstLine(File file, String encoding)
protected void	writeToFile(File file, String encoding, String line)

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

playVersion

@Parameter(property="play2.version")
protected String playVersion

Used to automatically select one of the "well known" Play! providers if no provider added explicitly as plugin's dependency.

Since:

1.0.0

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

Maven Internal: Project to interact with.

session

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected org.apache.maven.execution.MavenSession session

The current build session instance.

localRepo

@Parameter(property="localRepository",
           readonly=true,
           required=true)
protected org.apache.maven.artifact.repository.ArtifactRepository localRepo

Location of the local repository.

remoteRepos

@Parameter(property="project.remoteArtifactRepositories",
           readonly=true,
           required=true)
protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepos

Remote repositories used by the resolver

repositorySystem

@Component
protected org.apache.maven.repository.RepositorySystem repositorySystem

...

resolutionErrorHandler

@Component
protected org.apache.maven.artifact.resolver.ResolutionErrorHandler resolutionErrorHandler

...

pluginGroupId

@Parameter(property="plugin.groupId",
           readonly=true,
           required=true)
protected String pluginGroupId

Plugin's groupId used for well known providers resolution

pluginVersion

@Parameter(property="plugin.version",
           readonly=true,
           required=true)
protected String pluginVersion

Plugin's version used for well known providers resolution

Constructor Detail

AbstractPlay2Mojo

public AbstractPlay2Mojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

internalExecute

protected abstract void internalExecute()
                                 throws org.apache.maven.plugin.MojoExecutionException,
                                        org.apache.maven.plugin.MojoFailureException,
                                        IOException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

IOException

createBufferedFileReader

protected final BufferedReader createBufferedFileReader(File file,
                                                        String encoding)
                                                 throws FileNotFoundException,
                                                        UnsupportedEncodingException

Throws:

FileNotFoundException

UnsupportedEncodingException

createBufferedFileWriter

protected final BufferedWriter createBufferedFileWriter(File file,
                                                        String encoding)
                                                 throws FileNotFoundException,
                                                        UnsupportedEncodingException

Throws:

FileNotFoundException

UnsupportedEncodingException

readFileFirstLine

protected String readFileFirstLine(File file,
                                   String encoding)
                            throws IOException

Throws:

IOException

writeToFile

protected void writeToFile(File file,
                           String encoding,
                           String line)
                    throws IOException

Throws:

IOException

createDirectory

protected void createDirectory(File directory,
                               boolean overwrite)
                        throws IOException

Throws:

IOException

getProvider

protected Play2Provider getProvider()
                             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getResolvedArtifact

protected Set<org.apache.maven.artifact.Artifact> getResolvedArtifact(String groupId,
                                                                      String artifactId,
                                                                      String version)
                                                               throws org.apache.maven.artifact.resolver.ArtifactResolutionException

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException

getResolvedArtifact

protected Set<org.apache.maven.artifact.Artifact> getResolvedArtifact(String groupId,
                                                                      String artifactId,
                                                                      String version,
                                                                      boolean transitively)
                                                               throws org.apache.maven.artifact.resolver.ArtifactResolutionException

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException

getResolvedArtifact

protected Set<org.apache.maven.artifact.Artifact> getResolvedArtifact(org.apache.maven.artifact.Artifact artifact,
                                                                      boolean transitively)
                                                               throws org.apache.maven.artifact.resolver.ArtifactResolutionException

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException

isMatchingProject

protected boolean isMatchingProject(org.apache.maven.project.MavenProject p,
                                    String selector)