liquibase.integration.ant
Class DBDocTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by liquibase.integration.ant.BaseLiquibaseTask
              extended by liquibase.integration.ant.DBDocTask
All Implemented Interfaces:
Cloneable

public class DBDocTask
extends BaseLiquibaseTask


Nested Class Summary
 
Nested classes/interfaces inherited from class liquibase.integration.ant.BaseLiquibaseTask
BaseLiquibaseTask.ChangeLogProperty, BaseLiquibaseTask.LogRedirector
 
Field Summary
 
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
 
Constructor Summary
DBDocTask()
           
 
Method Summary
 void executeWithLiquibaseClassloader()
           
protected  String getChangeLogFile()
          This method is designed to be overridden by subclasses when a change log is needed.
 org.apache.tools.ant.types.resources.FileResource getOutputDirectory()
           
 void setChangeLogFile(String changeLog)
           
 void setContexts(String contexts)
          This method no longer does anything.
 void setOutputDirectory(org.apache.tools.ant.types.resources.FileResource outputDirectory)
           
protected  void validateParameters()
          Subclasses that override this method must always call super.validateParameters() method.
 
Methods inherited from class liquibase.integration.ant.BaseLiquibaseTask
addChangeLogParameters, addConfiguredChangeLogProperty, addDatabase, closeDatabase, closeDatabase, createClasspath, createDatabaseFromConfiguredDatabaseType, createDatabaseFromType, createDatabaseObject, createLiquibase, createOutputWriter, createPrintStream, execute, getContexts, getCurrentDateTimeFunction, getDatabaseChangeLogLockTableName, getDatabaseChangeLogObjectsTablespace, getDatabaseChangeLogTableName, getDatabaseClass, getDefaultCatalogName, getDefaultOutputEncoding, getDefaultSchemaName, getDriver, getLiquibase, getLogLevel, getOutputFile, getPassword, getUrl, getUsername, init, isOutputDefaultCatalog, isOutputDefaultSchema, isPromptOnNonLocalDatabase, setChangeLogParametersRef, setClasspathRef, setCurrentDateTimeFunction, setDatabaseChangeLogLockTableName, setDatabaseChangeLogObjectsTablespace, setDatabaseChangeLogTableName, setDatabaseClass, setDatabaseRef, setDefaultCatalogName, setDefaultSchemaName, setDriver, setLogLevel, setOutputDefaultCatalog, setOutputDefaultSchema, setOutputEncoding, setOutputFile, setPassword, setPromptOnNonLocalDatabase, setUrl, setUsername, shouldRun
 
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DBDocTask

public DBDocTask()
Method Detail

executeWithLiquibaseClassloader

public void executeWithLiquibaseClassloader()
                                     throws org.apache.tools.ant.BuildException
Specified by:
executeWithLiquibaseClassloader in class BaseLiquibaseTask
Throws:
org.apache.tools.ant.BuildException

validateParameters

protected void validateParameters()
Description copied from class: BaseLiquibaseTask
Subclasses that override this method must always call super.validateParameters() method.

Overrides:
validateParameters in class BaseLiquibaseTask

getChangeLogFile

protected String getChangeLogFile()
Description copied from class: BaseLiquibaseTask
This method is designed to be overridden by subclasses when a change log is needed. By default it returns null.

Overrides:
getChangeLogFile in class BaseLiquibaseTask
Returns:
Returns null in this implementation. Subclasses that need a change log should implement.
See Also:
AbstractChangeLogBasedTask.getChangeLogFile()

getOutputDirectory

public org.apache.tools.ant.types.resources.FileResource getOutputDirectory()

setOutputDirectory

public void setOutputDirectory(org.apache.tools.ant.types.resources.FileResource outputDirectory)

setChangeLogFile

public void setChangeLogFile(String changeLog)
Overrides:
setChangeLogFile in class BaseLiquibaseTask

setContexts

public void setContexts(String contexts)
Description copied from class: BaseLiquibaseTask
This method no longer does anything. Please extend from AbstractChangeLogBasedTask which has the equivalent method.

Overrides:
setContexts in class BaseLiquibaseTask


Copyright © 2016 Liquibase.org. All rights reserved.