org.jibx.schema.plugin

Class CreateProjectDocsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jibx.schema.plugin.CreateProjectDocsMojo

All Implemented Interfaces:

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

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

Schema library documentation generator.

Author:

Don Corley

Field Summary

Fields

Modifier and Type	Field and Description
static String	STRING_ENCODING
static String	URL_ENCODING

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

ROLE

Constructor Summary

Constructors

Constructor and Description
CreateProjectDocsMojo()

Method Summary

Modifier and Type	Method and Description
void	execute() Run
org.jibx.schema.org.apache.maven.maven_v4_0_0.Model	getProjectInfo(InputStream inStream) Read the template into the model.
void	scanSubModules(List<String> modulesList, String moduleLocation, PrintStream printOut)
String	stripProcessingInstructions(String xml)
boolean	writeThisModel(org.jibx.schema.org.apache.maven.maven_v4_0_0.Model message, PrintStream out) Write this model to this outstream.

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

URL_ENCODING

public static final String URL_ENCODING

See Also:

Constant Field Values

STRING_ENCODING

public static final String STRING_ENCODING

See Also:

Constant Field Values

Constructor Detail

CreateProjectDocsMojo

public CreateProjectDocsMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Run

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

scanSubModules

public void scanSubModules(List<String> modulesList,
                           String moduleLocation,
                           PrintStream printOut)
                    throws IOException

Parameters:

modulesList -

moduleLocation -

printOut -

Throws:

IOException

getProjectInfo

public org.jibx.schema.org.apache.maven.maven_v4_0_0.Model getProjectInfo(InputStream inStream)

Read the template into the model.

Returns:

writeThisModel

public boolean writeThisModel(org.jibx.schema.org.apache.maven.maven_v4_0_0.Model message,
                              PrintStream out)

Write this model to this outstream.

Parameters:

message -

out -

Returns:

stripProcessingInstructions

public String stripProcessingInstructions(String xml)