liquibase.resource

Class AbstractPathResourceAccessor

java.lang.Object

liquibase.AbstractExtensibleObject

liquibase.resource.AbstractResourceAccessor

liquibase.resource.AbstractPathResourceAccessor

All Implemented Interfaces:

AutoCloseable, Cloneable, ExtensibleObject, ResourceAccessor

Direct Known Subclasses:

DirectoryResourceAccessor, ZipResourceAccessor

public abstract class AbstractPathResourceAccessor
extends AbstractResourceAccessor

Nested Class Summary

Nested classes/interfaces inherited from interface liquibase.resource.ResourceAccessor

ResourceAccessor.NotFoundResource

Constructor Summary

Constructors

Constructor and Description
AbstractPathResourceAccessor()

Method Summary

Modifier and Type	Method and Description
protected abstract Resource	createResource(Path file, String pathToAdd)
List<String>	describeLocations() Returns a description of the places this classloader will look for paths.
List<Resource>	getAll(String path) Returns all Resources at the given path.
protected abstract Path	getRootPath()
List<Resource>	search(String startPath, boolean recursive) Returns the path to all resources contained in the given path.
String	toString()

Methods inherited from class liquibase.AbstractExtensibleObject

clone, describe, equals, get, get, get, getAttributes, getFieldValue, getObjectMetaData, getValuePath, has, hashCode, set

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface liquibase.resource.ResourceAccessor

get, getExisting, list, openStream, openStreams

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Detail

AbstractPathResourceAccessor

public AbstractPathResourceAccessor()

Method Detail

getRootPath

protected abstract Path getRootPath()

toString

public String toString()

Overrides:

toString in class AbstractExtensibleObject

describeLocations

public List<String> describeLocations()

Description copied from interface: ResourceAccessor

Returns a description of the places this classloader will look for paths. Used in error messages and other troubleshooting cases.

getAll

public List<Resource> getAll(String path)
                      throws IOException

Description copied from interface: ResourceAccessor

Returns all Resources at the given path. For many resource accessors (such as a file system), only one resource can exist at a given spot, but some accessors (such as CompositeResourceAccessor or ClassLoaderResourceAccessor) can have multiple resources for a single path.

If the resourceAccessor returns multiple values, the returned List should be considered sorted for that resource accessor. For example, ClassLoaderResourceAccessor returns them in order based on the configured classloader. Order is important to pay attention to, because users may set GlobalConfiguration.DUPLICATE_FILE_MODE to pick the "best" file which is defined as "the first file from this function".

Returns:

null if no resources match the path

Throws:

IOException - if there is an unexpected error determining what is at the path

search

public List<Resource> search(String startPath,
                             boolean recursive)
                      throws IOException

Description copied from interface: ResourceAccessor

Returns the path to all resources contained in the given path. Multiple resources may be returned with the same path, but only if they are actually unique files. Order is important to pay attention to, they should be returned in a user-expected manner based on this resource accessor.

Should return an empty list if:

• Path does not exist

Should throw an exception if:

• Path is null
• Path is not a "directory"
• Path exists but cannot be read from

Parameters:

startPath - The path to lookup resources in.

recursive - Set to true and will return paths to contents in subdirectories as well.

Returns:

empty set if nothing was found

Throws:

IOException - if there is an error searching the system.

createResource

protected abstract Resource createResource(Path file,
                                           String pathToAdd)