net.flexmojos.oss.plugin.source

Class SourceViewMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

net.flexmojos.oss.plugin.source.SourceViewMojo

All Implemented Interfaces:

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

public class SourceViewMojo
extends org.apache.maven.plugin.AbstractMojo

Generate the "Source view" documentation from the sources, like Flex/Flash Builder does for the release builds. Users can they right click the application and view the sources.

This goal produces a syntax highlighted version of the as, mxml and html documents in the sources, and just copies other types of files. It also generates a navigation to browse the sources.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.io.filefilter.IOFileFilter	filter The file filter to use when processing source files.
protected String	outputEncoding Encoding to use for the generated documentation.
protected org.apache.maven.project.MavenProject	project The Maven project.
protected String	sourceViewDirectoryName The name of the directory containing the "View source" documentation.
protected org.apache.velocity.VelocityContext	velocityContext The instance of VelocityContext.
protected org.apache.velocity.app.VelocityEngine	velocityEngine The instance of VelocityEngine.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
SourceViewMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected String	getContentFrameSource() Resolve the file to assign as the source of the content frame in the generated documentation.
protected String	getHighlightFilter(String fileExtension) Get the syntax highlighting filter to use for a file extension.
protected void	processDirectory(File directory, File targetDirectory) Loop through source files in the directory and syntax highlight and/or copy them to the target directory.
protected void	processFile(File file, File targetDirectory) Syntax highlight and/or copy the source file to the target directory.
protected void	processTemplate(String templateName, File targetDirectory) Merge the given template with the velocityContext and produce the file in the output documentation.

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

project

protected org.apache.maven.project.MavenProject project

The Maven project.

sourceViewDirectoryName

protected String sourceViewDirectoryName

The name of the directory containing the "View source" documentation.

It must be the same as the one declared in the Flex application:

 <mx:Application [...] viewSourceURL="srcview">
    [...]
 </mx:Application>
 

outputEncoding

protected String outputEncoding

Encoding to use for the generated documentation.

velocityEngine

protected org.apache.velocity.app.VelocityEngine velocityEngine

The instance of VelocityEngine.

velocityContext

protected org.apache.velocity.VelocityContext velocityContext

The instance of VelocityContext.

filter

protected org.apache.commons.io.filefilter.IOFileFilter filter

The file filter to use when processing source files.

Constructor Detail

SourceViewMojo

public SourceViewMojo()

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

processDirectory

protected void processDirectory(File directory,
                                File targetDirectory)

Loop through source files in the directory and syntax highlight and/or copy them to the target directory.

Parameters:

directory - The source directory to process.

targetDirectory - The directory where to store the output.

processFile

protected void processFile(File file,
                           File targetDirectory)
                    throws IOException

Syntax highlight and/or copy the source file to the target directory.

Parameters:

file - The file to process.

targetDirectory - The directory where to store the output.

Throws:

IOException - If there was a file read/write exception.

getHighlightFilter

protected String getHighlightFilter(String fileExtension)

Get the syntax highlighting filter to use for a file extension.

Parameters:

fileExtension - the file extension to test.

Returns:

null if no filter available for this file type.

See Also:

XhtmlRendererFactory#getSupportedTypes()}

processTemplate

protected void processTemplate(String templateName,
                               File targetDirectory)
                        throws org.apache.maven.plugin.MojoFailureException

Merge the given template with the velocityContext and produce the file in the output documentation.

Parameters:

templateName - The name of the template to process.

targetDirectory - The directory where to store the output file.

Throws:

org.apache.maven.plugin.MojoFailureException - If the template could not be loaded, parsed, or the output file could not be written.

getContentFrameSource

protected String getContentFrameSource()

Resolve the file to assign as the source of the content frame in the generated documentation.

Tries to resolve the main source and defaults to a blank page if not found.

Returns:

The path to the page to use in the generated documentation.