com.vecna.maven.hibernate

Class HibernateDocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.vecna.maven.commons.AbstractClassLoaderSwappingMojo

com.vecna.maven.commons.BuildClassPathMojo

com.vecna.maven.hibernate.HibernateSchemaMojo

com.vecna.maven.hibernate.HibernateDocMojo

All Implemented Interfaces:

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

public class HibernateDocMojo
extends HibernateSchemaMojo

Generates schema documentation. This plugin enhances the Hibernate model with documentation extracted from the javadocs (sources must be provided). Then it feeds the Hibernate model into the Hibernate Tools DocExporter.

Author:

ogolberg@vecna.com

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
HibernateDocMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	executeWithMappings(org.hibernate.cfg.Configuration configuration) This method will be executed in the build classpath classloader context after the mapping metadata is built.

Methods inherited from class com.vecna.maven.hibernate.HibernateSchemaMojo

createMappings, executeWithClassLoader, getProject

Methods inherited from class com.vecna.maven.commons.BuildClassPathMojo

getClassLoader

Methods inherited from class com.vecna.maven.commons.AbstractClassLoaderSwappingMojo

execute

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

Constructor Detail

HibernateDocMojo

public HibernateDocMojo()

Method Detail

executeWithMappings

protected void executeWithMappings(org.hibernate.cfg.Configuration configuration)
                            throws org.apache.maven.plugin.MojoExecutionException,
                                   org.apache.maven.plugin.MojoFailureException

This method will be executed in the build classpath classloader context after the mapping metadata is built.

Specified by:

executeWithMappings in class HibernateSchemaMojo

Parameters:

configuration - mapping metadata.

Throws:

org.apache.maven.plugin.MojoExecutionException - on execution exception

org.apache.maven.plugin.MojoFailureException - on execution failure