org.codehaus.mojo.jsimport
Class AbstractGenerateHtmlMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.codehaus.mojo.jsimport.AbstractGenerateHtmlMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
GenerateHtmlMojo, TestGenerateHtmlMojo

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

Mojo for generating properties for filtering into html script elements. This uses the serialised file dependency graph provided by the import mojo.


Nested Class Summary
protected static class AbstractGenerateHtmlMojo.Scope
          The current project scope.
 
Field Summary
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractGenerateHtmlMojo()
           
 
Method Summary
 void doExecute(File sourceJsFolder, File mainSourceJsFolder, File htmlResourceFolder, File targetFolder, File mainTargetFolder, File workFolder, AbstractGenerateHtmlMojo.Scope scope)
          Perform the goal of this mojo.
 org.sonatype.plexus.build.incremental.BuildContext getBuildContext()
           
 String getEncoding()
           
 List<String> getExcludes()
           
 Map<String,LinkedHashSet<String>> getFileDependencies()
           
 List<String> getIncludes()
           
 org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()
           
 org.apache.maven.shared.filtering.MavenFileFilter getMavenFileFilter()
           
 org.apache.maven.project.MavenProject getProject()
           
 org.apache.maven.execution.MavenSession getSession()
           
 String getTargetJsPath()
           
 void setBuildContext(org.sonatype.plexus.build.incremental.BuildContext buildContext)
           
 void setEncoding(String encoding)
           
 void setExcludes(List<String> excludes)
           
 void setIncludes(List<String> includes)
           
 void setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)
           
 void setMavenFileFilter(org.apache.maven.shared.filtering.MavenFileFilter mavenFileFilter)
           
 void setProject(org.apache.maven.project.MavenProject project)
           
 void setSession(org.apache.maven.execution.MavenSession session)
           
 void setTargetJsPath(String targetJsPath)
           
 
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
 

Constructor Detail

AbstractGenerateHtmlMojo

public AbstractGenerateHtmlMojo()
Method Detail

doExecute

public void doExecute(File sourceJsFolder,
                      File mainSourceJsFolder,
                      File htmlResourceFolder,
                      File targetFolder,
                      File mainTargetFolder,
                      File workFolder,
                      AbstractGenerateHtmlMojo.Scope scope)
               throws org.apache.maven.plugin.MojoExecutionException
Perform the goal of this mojo.

Parameters:
sourceJsFolder - the folder where the source js files reside.
mainSourceJsFolder - the folder where the main source js files reside.
htmlResourceFolder - the folder where the resource html files reside.
targetFolder - where all files are going to end up.
mainTargetFolder - where all main files are going to end up.
workFolder - the folder where our work files can be found.
scope - scope the scope of the dependencies we are to search for.
Throws:
org.apache.maven.plugin.MojoExecutionException - if there is an execution failure.

getBuildContext

public org.sonatype.plexus.build.incremental.BuildContext getBuildContext()
Returns:
property.

getEncoding

public String getEncoding()
Returns:
property.

getExcludes

public List<String> getExcludes()
Returns:
property.

getFileDependencies

public Map<String,LinkedHashSet<String>> getFileDependencies()
Returns:
property.

getIncludes

public List<String> getIncludes()
Returns:
property.

getLocalRepository

public org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()
Returns:
property.

getMavenFileFilter

public org.apache.maven.shared.filtering.MavenFileFilter getMavenFileFilter()
Returns:
property.

getProject

public org.apache.maven.project.MavenProject getProject()
Returns:
property.

getSession

public org.apache.maven.execution.MavenSession getSession()
Returns:
property.

getTargetJsPath

public String getTargetJsPath()
Returns:
property.

setBuildContext

public void setBuildContext(org.sonatype.plexus.build.incremental.BuildContext buildContext)
Parameters:
buildContext - set property.

setEncoding

public void setEncoding(String encoding)
Parameters:
encoding - set property.

setExcludes

public void setExcludes(List<String> excludes)
Parameters:
excludes - set property.

setIncludes

public void setIncludes(List<String> includes)
Parameters:
includes - set property.

setLocalRepository

public void setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)
Parameters:
localRepository - set property.

setMavenFileFilter

public void setMavenFileFilter(org.apache.maven.shared.filtering.MavenFileFilter mavenFileFilter)
Parameters:
mavenFileFilter - set property.

setProject

public void setProject(org.apache.maven.project.MavenProject project)
Parameters:
project - property.

setSession

public void setSession(org.apache.maven.execution.MavenSession session)
Parameters:
session - property.

setTargetJsPath

public void setTargetJsPath(String targetJsPath)
Parameters:
targetJsPath - set property.


Copyright © 2010-2012 Codehaus. All Rights Reserved.