LiquibaseDBDocMojo (liquibase-maven-plugin 4.26.0 API)

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.

Field Summary
- Fields inherited from class org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo
  changeLogDirectory, changeLogFile, contexts, duplicateFileMode, labelFilter, labels
- Fields inherited from class org.liquibase.maven.plugins.AbstractLiquibaseMojo
  changeExecListenerClass, changeExecListenerPropertiesFile, changelogCatalogName, changelogSchemaName, clearCheckSums, commandName, databaseChangeLogLockTableName, databaseChangeLogTableName, databaseClass, defaultCatalogName, defaultChangeExecListener, defaultSchemaName, driver, emptyPassword, includeArtifact, includeTestOutputDirectory, logFormat, logging, logLevel, outputDefaultCatalog, outputDefaultSchema, outputFileEncoding, password, preserveSchemaCase, project, promptOnNonLocalDatabase, propertyFile, propertyFileWillOverride, propertyProviderClass, psqlArgs, psqlKeepTemp, psqlKeepTempName, psqlKeepTempPath, psqlLogFile, psqlPath, psqlTimeout, searchPath, showBanner, skip, skipOnFileExists, sqlcmdArgs, sqlcmdCatalogName, sqlcmdKeepTemp, sqlcmdKeepTempName, sqlcmdKeepTempOverwrite, sqlcmdKeepTempPath, sqlcmdLogFile, sqlcmdPath, sqlcmdTimeout, sqlPlusArgs, sqlPlusKeepTemp, sqlPlusKeepTempName, sqlPlusKeepTempOverwrite, sqlPlusKeepTempPath, sqlPlusLogFile, sqlPlusPath, sqlPlusTimeout, systemProperties, url, username, verbose, wagonManager
- Fields inherited from interface org.apache.maven.plugin.Mojo
  ROLE

Constructor Summary

Constructors
Constructor Description

LiquibaseDBDocMojo()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getOutputDirectory()`
`protected void`	`performLiquibaseTask(liquibase.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, getLabelFilter, getResourceAccessor, printSettings

Methods inherited from class org.liquibase.maven.plugins.AbstractLiquibaseMojo
cleanup, configureChangeLogProperties, configureFieldsAndValues, databaseConnectionRequired, execute, getClassLoaderIncludingProjectClasspath, getField, getLicenseKey, getLiquibase, getLog, getMavenArtifactClassLoader, getOutputStream, getOutputWriter, isPromptOnNonLocalDatabase, parsePropertiesFile, setupBindInfoPackage

Methods inherited from class org.apache.maven.plugin.AbstractMojo
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 liquibase)
                             throws liquibase.exception.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:
    
    liquibase.exception.LiquibaseException
  - getOutputDirectory
```
public String getOutputDirectory()
```