org.liquibase.maven.plugins

Class LiquibaseDBDocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

org.liquibase.maven.plugins.LiquibaseDBDocMojo

All Implemented Interfaces:

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

public class LiquibaseDBDocMojo
extends AbstractLiquibaseChangeLogMojo

Generates dbDocs against the database.

Author:

Ryan Connolly

Field Summary

Fields inherited from class org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

changeLogDirectory, changeLogFile, contexts, labels

Fields inherited from class org.liquibase.maven.plugins.AbstractLiquibaseMojo

changelogCatalogName, changelogSchemaName, clearCheckSums, databaseChangeLogLockTableName, databaseChangeLogTableName, databaseClass, defaultCatalogName, defaultSchemaName, driver, emptyPassword, includeArtifact, includeTestOutputDirectory, logging, outputDefaultCatalog, outputDefaultSchema, outputFileEncoding, password, project, promptOnNonLocalDatabase, propertyFile, propertyFileWillOverride, propertyProviderClass, skip, systemProperties, url, username, verbose, wagonManager

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

ROLE

Constructor Summary

Constructors

Constructor and Description
LiquibaseDBDocMojo()

Method Summary

Methods

Modifier and Type	Method and Description
String	getOutputDirectory()
protected void	performLiquibaseTask(Liquibase liquibase) Performs the actual Liquibase task on the database using the fully configured Liquibase.

Methods inherited from class org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

checkRequiredParametersAreSpecified, createLiquibase, getFileOpener, printSettings

Methods inherited from class org.liquibase.maven.plugins.AbstractLiquibaseMojo

cleanup, configureFieldsAndValues, execute, getClassLoaderIncludingProjectClasspath, getLiquibase, getMavenArtifactClassLoader, getOutputWriter, isPromptOnNonLocalDatabase, parsePropertiesFile

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

LiquibaseDBDocMojo

public LiquibaseDBDocMojo()

Method Detail

performLiquibaseTask

protected void performLiquibaseTask(Liquibase liquibase)
                             throws LiquibaseException

Description copied from class: AbstractLiquibaseChangeLogMojo

Performs the actual Liquibase task on the database using the fully configured Liquibase.

Overrides:

performLiquibaseTask in class AbstractLiquibaseChangeLogMojo

Parameters:

liquibase - The Liquibase that has been fully configured to run the desired database task.

Throws:

LiquibaseException

getOutputDirectory

public String getOutputDirectory()