HelpGeneratorMojo (Maven Plugin Tools 3.5.2 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.plugin.plugin.AbstractGeneratorMojo
  - - org.apache.maven.plugin.plugin.HelpGeneratorMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
```
@Mojo(name="helpmojo",
      defaultPhase=GENERATE_SOURCES,
      threadSafe=true,
      requiresDependencyResolution=COMPILE)
public class HelpGeneratorMojo
extends AbstractGeneratorMojo
```
Generates a HelpMojo class.

Since:

2.4

Version:

$Id: HelpGeneratorMojo.html 1030109 2018-05-20 14:45:18Z hboutemy $

Author:

Vincent Siveton

- Field Summary
  
  Fields
  Modifier and Type Field and Description
  
  protected File outputDirectory
  The directory where the generated HelpMojo file will be put.
  - Fields inherited from class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
    dependencies, encoding, extractors, goalPrefix, local, mojoScanner, packagingTypes, project, remoteRepos, skip, skipErrorNoDescriptorsFound
  - Fields inherited from interface org.apache.maven.plugin.Mojo
    ROLE
- Constructor Summary
  
  Constructors
  Constructor and Description
  
  HelpGeneratorMojo()
- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  protected Generator createGenerator()
  
  void execute()
  
  protected File getOutputDirectory()
  - 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(defaultValue="${project.build.directory}/generated-sources/plugin")
protected File outputDirectory
```
    The directory where the generated HelpMojo file will be put.
- Constructor Detail
  - HelpGeneratorMojo
```
public HelpGeneratorMojo()
```
- Method Detail
  - getOutputDirectory
```
protected File getOutputDirectory()
```
    Specified by:
    
    getOutputDirectory in class AbstractGeneratorMojo
    
    Returns:
    the output directory where files will be generated.
  - createGenerator
```
protected Generator createGenerator()
```
    Specified by:
    
    createGenerator in class AbstractGeneratorMojo
    
    Returns:
    the wanted Generator implementation.
  - execute
```
public void execute()
             throws org.apache.maven.plugin.MojoExecutionException
```
    Specified by:
    
    execute in interface org.apache.maven.plugin.Mojo
    
    Overrides:
    
    execute in class AbstractGeneratorMojo
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2004–2018 The Apache Software Foundation. All rights reserved.