liquibase.resource

Class PathHandlerFactory

java.lang.Object

liquibase.plugin.AbstractPluginFactory<PathHandler>

liquibase.resource.PathHandlerFactory

All Implemented Interfaces:

PluginFactory, SingletonObject

public class PathHandlerFactory
extends AbstractPluginFactory<PathHandler>

Singleton for working with PathHandlers.

Method Summary

Modifier and Type	Method and Description
OutputStream	createResource(String resourcePath) Creates a new resource at the specified path and returns an OutputStream for writing to it.
protected Class<PathHandler>	getPluginClass()
protected int	getPriority(PathHandler obj, Object... args) Returns the priority of the given object based on the passed args array.
Resource	getResource(String resourcePath) Return the resource for the given path.
ResourceAccessor	getResourceAccessor(String root) Creates a ResourceAccessor for the given path.
OutputStream	openResourceOutputStream(String resourcePath, boolean createIfNotExists) Deprecated. use openResourceOutputStream(String, OpenOptions)
OutputStream	openResourceOutputStream(String resourcePath, OpenOptions openOptions) Returns the outputStream from getResource(String), using settings from the passed OpenOptions.

Methods inherited from class liquibase.plugin.AbstractPluginFactory

findAllInstances, getPlugin, register, removeInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPluginClass

protected Class<PathHandler> getPluginClass()

Specified by:

getPluginClass in class AbstractPluginFactory<PathHandler>

getPriority

protected int getPriority(PathHandler obj,
                          Object... args)

Description copied from class: AbstractPluginFactory

Returns the priority of the given object based on the passed args array. The args are created as as part of the custom public getPlugin method in implementations are are passed through AbstractPluginFactory.getPlugin(Object...)

Specified by:

getPriority in class AbstractPluginFactory<PathHandler>

getResourceAccessor

public ResourceAccessor getResourceAccessor(String root)
                                     throws IOException

Creates a ResourceAccessor for the given path.

Throws:

IOException

createResource

public OutputStream createResource(String resourcePath)
                            throws IOException

Creates a new resource at the specified path and returns an OutputStream for writing to it.

Throws:

FileAlreadyExistsException - if the file already exists

IOException - if the path cannot be written to

getResource

public Resource getResource(String resourcePath)
                     throws IOException

Return the resource for the given path.

Returns:

A resource, regardless of whether it exists or not.

Throws:

IOException - if the path cannot be understood or if there is a problem parsing the path

IOException - if the path exists as both a direct resourcePath and also in the resourceAccessor (if included). Unless GlobalConfiguration.DUPLICATE_FILE_MODE overrides that behavior.

openResourceOutputStream

@Deprecated
public OutputStream openResourceOutputStream(String resourcePath,
                                                         boolean createIfNotExists)
                                                  throws IOException

Deprecated. use openResourceOutputStream(String, OpenOptions)

Returns the outputStream from getResource(String) if it exists, and the outputStream from createResource(String) if it does not.

Returns:

null if resourcePath does not exist and createIfNotExists is false

Throws:

IOException - if there is an error opening the stream

openResourceOutputStream

public OutputStream openResourceOutputStream(String resourcePath,
                                             OpenOptions openOptions)
                                      throws IOException

Returns the outputStream from getResource(String), using settings from the passed OpenOptions.

Returns:

null if resourcePath does not exist and OpenOptions.isCreateIfNeeded() is false

Throws:

IOException - if there is an error opening the stream