Package liquibase.io

Interface OutputFileHandler

All Superinterfaces:

Plugin

All Known Implementing Classes:

StandardOutputFileHandler

public interface OutputFileHandler
extends Plugin

The OutputFileHandler interface defines methods for handling log output files in Liquibase.

Field Summary

Fields inherited from interface liquibase.plugin.Plugin

PRIORITY_DATABASE, PRIORITY_DEFAULT, PRIORITY_NOT_APPLICABLE, PRIORITY_SPECIALIZED

Method Summary

Modifier and Type	Method	Description
void	close()	Closes any resources associated with the output file handler.
void	create(String outputFile, CommandScope commandScope)	Creates a new output file with the specified name and sets the output stream in the command scope.
int	getPriority()	Returns the priority of the output file handler based on the specified output file.

Method Details

getPriority

int getPriority()

Returns the priority of the output file handler based on the specified output file.

Returns:

the priority of the output file handler

create

void create(String outputFile,
 CommandScope commandScope)
     throws IOException

Creates a new output file with the specified name and sets the output stream in the command scope.

Parameters:

outputFile - the path or name of the output file to create

commandScope - the scope of the command that triggered the creation of the output file

Throws:

IOException - if an I/O error occurs while creating the output file

close

void close()
    throws IOException

Closes any resources associated with the output file handler.

Throws:

IOException - if an I/O error occurs while closing the output stream