org.liquibase.maven.plugins

Class MavenResourceAccessor

java.lang.Object

liquibase.resource.AbstractResourceAccessor

liquibase.resource.ClassLoaderResourceAccessor

org.liquibase.maven.plugins.MavenResourceAccessor

All Implemented Interfaces:

ResourceAccessor

public class MavenResourceAccessor
extends ClassLoaderResourceAccessor

Extension of ClassLoaderResourceAccessor for Maven which will use a default or user specified ClassLoader to load files/resources.

Constructor Summary

Constructors

Constructor and Description
MavenResourceAccessor()
MavenResourceAccessor(ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
Set<InputStream>	getResourcesAsStream(String path) Return an InputStream for each resource mapped by the given path.
Set<String>	list(String relativeTo, String path, boolean includeFiles, boolean includeDirectories, boolean recursive) Returns the path to all resources contained in the given root.

Methods inherited from class liquibase.resource.ClassLoaderResourceAccessor

toClassLoader, toString

Methods inherited from class liquibase.resource.AbstractResourceAccessor

addRootPath, convertToPath, convertToPath, getContents, getRootPaths, init, isCaseSensitive

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenResourceAccessor

public MavenResourceAccessor()

MavenResourceAccessor

public MavenResourceAccessor(ClassLoader classLoader)

Method Detail

getResourcesAsStream

public Set<InputStream> getResourcesAsStream(String path)
                                      throws IOException

Description copied from interface: ResourceAccessor

Return an InputStream for each resource mapped by the given path. The path is often a URL but does not have to be.

Specified by:

getResourcesAsStream in interface ResourceAccessor

Overrides:

getResourcesAsStream in class ClassLoaderResourceAccessor

Returns:

null if the resource does not exist.

Throws:

IOException - if there is an error reading an existing path.

list

public Set<String> list(String relativeTo,
                        String path,
                        boolean includeFiles,
                        boolean includeDirectories,
                        boolean recursive)
                 throws IOException

Description copied from interface: ResourceAccessor

Returns the path to all resources contained in the given root. The passed root is not included in the returned set.

Specified by:

list in interface ResourceAccessor

Overrides:

list in class ClassLoaderResourceAccessor

includeFiles - Set to false to exclude files in the returned set. Defaults to true

includeDirectories - Set to false to exclude directories in the returned set. Defaults to true

recursive - Set to true and will return paths to contents in sub directories as well. Defaults to false

Returns:

null if the root does not exist.

Throws:

IOException - if there is an error reading an existing root.