liquibase.resource

Class FileSystemResourceAccessor

java.lang.Object

liquibase.AbstractExtensibleObject

liquibase.resource.AbstractResourceAccessor

liquibase.resource.FileSystemResourceAccessor

All Implemented Interfaces:

Cloneable, ExtensibleObject, ResourceAccessor

Direct Known Subclasses:

AntResourceAccessor

public class FileSystemResourceAccessor
extends AbstractResourceAccessor

A @{link ResourceAccessor} implementation for files on the file system. Will look for files in zip and jar files if they are added as root paths.

Constructor Summary

Constructors

Constructor and Description
FileSystemResourceAccessor(File... baseDirsAndFiles) Creates a FileSystemResourceAccessor with the given directories/files as the roots.
FileSystemResourceAccessor(String file) Deprecated. use FileSystemResourceAccessor(File...)

Method Summary

Modifier and Type	Method and Description
protected void	addRootPath(Path path)
SortedSet<String>	describeLocations() Returns a description of the places this classloader will look for paths.
protected LinkedHashSet<Path>	getRootPaths()
protected boolean	isCompressedFile(Path path) Returns true if the given path is a compressed file.
SortedSet<String>	list(String relativeTo, String path, boolean recursive, boolean includeFiles, boolean includeDirectories) Returns the path to all resources contained in the given path.
InputStreamList	openStreams(String relativeTo, String streamPath) Return the streams for each resource mapped by the given path.
protected File	toFile(String path)
String	toString()

Methods inherited from class liquibase.resource.AbstractResourceAccessor

openStream

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

Constructor Detail

FileSystemResourceAccessor

public FileSystemResourceAccessor(File... baseDirsAndFiles)

Creates a FileSystemResourceAccessor with the given directories/files as the roots.

FileSystemResourceAccessor

public FileSystemResourceAccessor(String file)

Deprecated. use FileSystemResourceAccessor(File...)

Method Detail

addRootPath

protected void addRootPath(Path path)

getRootPaths

protected LinkedHashSet<Path> getRootPaths()

toFile

protected File toFile(String path)

openStreams

public InputStreamList openStreams(String relativeTo,
                                   String streamPath)
                            throws IOException

Description copied from interface: ResourceAccessor

Return the streams for each resource mapped by the given path. The path is often a URL but does not have to be. Should accept both / and \ chars for file paths to be platform-independent. If path points to a compressed resource, return a stream of the uncompressed contents of the file. Returns InputStreamList since multiple resources can map to the same path, such as "META-INF/MAINFEST.MF". Remember to close streams when finished with them.

Parameters:

relativeTo - Location that streamPath should be found relative to. If null, streamPath is an absolute path

Returns:

Empty list if the resource does not exist.

Throws:

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

list

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

Description copied from interface: ResourceAccessor

Returns the path to all resources contained in the given path. The passed path is not included in the returned set. Returned strings should use "/" for file path separators, regardless of the OS and should accept both / and \ chars for file paths to be platform-independent. Returned set is sorted, normally alphabetically but subclasses can use different comparators. The values returned should be able to be passed into ResourceAccessor.openStreams(String, String) and return the contents. Returned paths should normally be root-relative and therefore not be an absolute path, unless there is a good reason to be absolute.

Parameters:

relativeTo - Location that streamPath should be found relative to. If null, path is an absolute path

path - The path to lookup resources in.

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

includeFiles - Set to true and will return paths to files.

includeDirectories - Set to true and will return paths to directories.

Returns:

empty set if nothing was found

Throws:

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

isCompressedFile

protected boolean isCompressedFile(Path path)

Returns true if the given path is a compressed file.

toString

public String toString()

Overrides:

toString in class AbstractExtensibleObject

describeLocations

public SortedSet<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.