org.apache.maven.doxia.plugin
Class DoxiaRenderBooksMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.doxia.plugin.DoxiaRenderBooksMojo
All Implemented Interfaces:
ContextEnabled, Mojo

public class DoxiaRenderBooksMojo
extends AbstractMojo

A Mojo to create books in different output formats.

Since:
1.0
Version:
$Id: DoxiaRenderBooksMojo.java 1090706 2011-04-09 23:15:28Z hboutemy $
Author:
Trygve Laugstøl
Is defined by the goal name:
render-books

Field Summary
protected  String locales
          A comma separated list of locales supported by Maven.
protected  SiteTool siteTool
          SiteTool.
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
DoxiaRenderBooksMojo()
           
 
Method Summary
 void execute()
           Executes the Mojo.
protected  String getInputEncoding()
          Gets the input files encoding.
protected  String getOutputEncoding()
          Gets the effective reporting output files encoding.
 
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

siteTool

protected SiteTool siteTool
SiteTool.

Is a Plexus component defined by:

locales

protected String locales
A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.

Is defined by:
default-value:
${locales}
Constructor Detail

DoxiaRenderBooksMojo

public DoxiaRenderBooksMojo()
Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException
Executes the Mojo.

Throws:
MojoExecutionException
MojoFailureException

getInputEncoding

protected String getInputEncoding()
Gets the input files encoding.

Returns:
The input files encoding, never null.
Since:
1.1

getOutputEncoding

protected String getOutputEncoding()
Gets the effective reporting output files encoding.

Returns:
The effective reporting output file encoding, never null.
Since:
1.1


Copyright © 2005-2012 The Apache Software Foundation. All Rights Reserved.