ProtocCompileJavaScriptMojo

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.xolstice.maven.plugin.protobuf.AbstractProtocMojo
  - - org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo
    - - org.xolstice.maven.plugin.protobuf.ProtocCompileJavaScriptMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
```
@Mojo(name="compile-js",
      defaultPhase=GENERATE_SOURCES,
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
public final class ProtocCompileJavaScriptMojo
extends AbstractProtocCompileMojo
```
This mojo executes the protoc compiler for generating main JavaScript sources from protocol buffer definitions. It also searches dependency artifacts for .proto files and includes them in the proto_path so that they can be referenced. Finally, it adds the .proto files to the project as resources so that they are included in the final artifact.

Since:

0.6.0

Field Summary

Fields
Modifier and Type	Field	Description
`private java.lang.String`	`javaScriptOptions`	Additional comma-separated options to be passed to the JavaScript generator.
`private java.io.File`	`outputDirectory`	This is the directory into which the `.js` will be created.

Fields inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo
descriptorSetClassifier

Fields inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo
attachDescriptorSet, attachProtoSources, buildContext, descriptorSetFileName, includeDependenciesInDescriptorSet, includeSourceInfoInDescriptorSet, project, projectHelper, session, toolchainManager, useArgumentFile, writeDescriptorSet

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

Constructor Summary

Constructors
Constructor Description

ProtocCompileJavaScriptMojo()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addProtocBuilderParameters(Protoc.Builder protocBuilder)`	Adds mojo-specific parameters to the protoc builder.
`protected java.io.File`	`getOutputDirectory()`	Returns the output directory for generated sources.

Methods inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo
doAttachGeneratedFiles, doAttachProtoSources, getDependencyArtifacts, getDescriptorSetOutputDirectory, getProtoSourceRoot

Methods inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo
checkFilesUpToDate, checkParameters, createDependencyArtifact, createDependencyArtifact, createProtocPlugins, detectJavaHome, doAttachFiles, execute, findGeneratedFilesInDirectory, findProtoFilesInDirectories, findProtoFilesInDirectory, getDependencyArtifactFiles, getExcludes, getIncludes, hasDelta, lastModified, makeProtoPathFromJars, resolveBinaryArtifact, skipMojo, toHexString, truncatePath

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
  - outputDirectory
```
@Parameter(required=true,
           property="javaScriptOutputDirectory",
           defaultValue="${project.build.directory}/generated-sources/protobuf/js")
private java.io.File outputDirectory
```
    This is the directory into which the .js will be created.
  - javaScriptOptions
```
@Parameter(required=false,
           property="javaScriptOptions")
private java.lang.String javaScriptOptions
```
    Additional comma-separated options to be passed to the JavaScript generator. Cannot contain colon (:) symbols.
- Constructor Detail
  - ProtocCompileJavaScriptMojo
```
public ProtocCompileJavaScriptMojo()
```
- Method Detail
  - addProtocBuilderParameters
```
protected void addProtocBuilderParameters(Protoc.Builder protocBuilder)
```
    Description copied from class: AbstractProtocMojo
    
    Adds mojo-specific parameters to the protoc builder.
    
    Overrides:
    
    addProtocBuilderParameters in class AbstractProtocMojo
    
    Parameters:
    
    protocBuilder - the builder to be modified.
  - getOutputDirectory
```
protected java.io.File getOutputDirectory()
```
    Description copied from class: AbstractProtocMojo
    
    Returns the output directory for generated sources. Depends on build phase so must be defined in concrete implementation.
    
    Specified by:
    
    getOutputDirectory in class AbstractProtocMojo
    
    Returns:
    
    output directory for generated sources.