org_scala_tools_maven
Class ScalaGenJsonMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org_scala_tools_maven.ScalaMojoSupport
          org_scala_tools_maven.ScalaSourceMojoSupport
              org_scala_tools_maven.ScalaGenJsonMojo

All Implemented Interfaces:

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

public class ScalaGenJsonMojo
extends ScalaSourceMojoSupport

Produces Scala API documentation in Json (use vscaladoc2_genjson).

Since:

2.15.0

Nested Class Summary

protected static class

ScalaGenJsonMojo.Cfg

Field Summary

protected String	_mainClass
protected boolean	_prettyPrint
protected String	license Define the html fragment for license (default : use info of the first entry of pom.xml/project/licenses).
protected String	logo Define the html fragment for logo.
protected File	sourceDir The directory which contains scala/java source files
protected String	tags Define the artifact's tags (space separator).
protected String	vscaladoc2Version Define the version of vscaladoc2_genjson to use.

Fields inherited from class org_scala_tools_maven.ScalaSourceMojoSupport

excludes, includes, sendJavaToScalac

Fields inherited from class org_scala_tools_maven.ScalaMojoSupport

args, checkMultipleScalaVersions, compilerPlugins, dependencies, displayCmd, factory, failOnMultipleScalaVersions, forceUseArgFile, fork, jvmArgs, localRepo, mavenProjectBuilder, project, remoteRepos, resolver, SCALA_GROUPID, SCALA_LIBRARY_ARTIFACTID, scalaClassName

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

ROLE

Constructor Summary

ScalaGenJsonMojo()

Method Summary

protected void	doExecute()
protected List<File>	getSourceDirectories() Retreives the list of *all* root source directories.

Methods inherited from class org_scala_tools_maven.ScalaSourceMojoSupport

findSourceWithFilters, findSourceWithFilters, initFilters, normalize, normalize

Methods inherited from class org_scala_tools_maven.ScalaMojoSupport

addCompilerPluginOptions, addToClasspath, addToClasspath, addToClasspath, checkScalaVersion, execute, findScalaVersion, getDependencies, getEmptyScalaCommand, getScalaCommand, isJavaSupportedByCompiler, resolveArtifactDependencies, resolveDependencyArtifacts

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

logo

protected String logo

Define the html fragment for logo.

license

protected String license

Define the html fragment for license (default : use info of the first entry of pom.xml/project/licenses).

tags

protected String tags

Define the artifact's tags (space separator).

vscaladoc2Version

protected String vscaladoc2Version

Define the version of vscaladoc2_genjson to use.

sourceDir

protected File sourceDir

The directory which contains scala/java source files

_mainClass

protected String _mainClass

_prettyPrint

protected boolean _prettyPrint

Constructor Detail

ScalaGenJsonMojo

public ScalaGenJsonMojo()
                 throws Exception

Throws:

Exception

Method Detail

getSourceDirectories

protected List<File> getSourceDirectories()
                                   throws Exception

Description copied from class: ScalaSourceMojoSupport

Retreives the list of *all* root source directories. We need to pass all .java and .scala files into the scala compiler

Specified by:

getSourceDirectories in class ScalaSourceMojoSupport

Throws:

Exception

doExecute

protected void doExecute()
                  throws Exception

Specified by:

doExecute in class ScalaMojoSupport

Throws:

Exception