org.codehaus.mojo.servicedocgen.generation.velocity

Class VelocityServicesGenerator

java.lang.Object

org.codehaus.mojo.servicedocgen.generation.velocity.VelocityServicesGenerator

All Implemented Interfaces:

ServicesGenerator

public class VelocityServicesGenerator
extends Object
implements ServicesGenerator

Implementation of ServicesDescriptor based on apache velocity.

Author:

hohwille

Constructor Summary

Constructors

Constructor and Description
VelocityServicesGenerator(String templatePath) The constructor.

Method Summary

Modifier and Type	Method and Description
void	generate(ServicesDescriptor descriptor, File outputDirectory, String filename, String openApiUrl) Generates the documentation as output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VelocityServicesGenerator

public VelocityServicesGenerator(String templatePath)

The constructor.

Parameters:

templatePath - the classpath location where to look for velocity templates.

Method Detail

generate

public void generate(ServicesDescriptor descriptor,
                     File outputDirectory,
                     String filename,
                     String openApiUrl)
              throws IOException

Generates the documentation as output.

Specified by:

generate in interface ServicesGenerator

Parameters:

descriptor - the ServicesDescriptor with the collected meta-data.

outputDirectory - the directory where to write the output to.

filename - the name of the file to write the output to.

openApiUrl - the url to the OpenApi file

Throws:

IOException - if something goes wrong.