liquibase.resource

Class AbstractResource

java.lang.Object

liquibase.resource.AbstractResource

All Implemented Interfaces:

Resource

Direct Known Subclasses:

MockResource, PathResource, ResourceAccessor.NotFoundResource, URIResource

public abstract class AbstractResource
extends Object
implements Resource

Constructor Summary

Constructors

Constructor and Description
AbstractResource(String path, URI uri)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getPath() Returns the normalized, ResourceAccessor-relative path for this resource.
URI	getUri() Returns a unique and complete identifier for this resource.
int	hashCode()
boolean	isWritable() Return true if the resource can be written to
OutputStream	openOutputStream(boolean createIfNeeded) Opens an output stream to write to this resource.
protected String	resolvePath(String other) Convenience method for computing the relative path in Resource.resolve(String) implementations
protected String	resolveSiblingPath(String other) Convenience method for computing the relative path in Resource.resolveSibling(String) implementations.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface liquibase.resource.Resource

exists, openInputStream, resolve, resolveSibling

Constructor Detail

AbstractResource

public AbstractResource(String path,
                        URI uri)

Method Detail

getPath

public String getPath()

Description copied from interface: Resource

Returns the normalized, ResourceAccessor-relative path for this resource. To get the unique location of this resource, use Resource.getUri() This should always use `/` for separators This should not include any sort of protocol or prefixes This should not have a leading /. This should have any relative paths smoothed out -- return "path/to/resource" not "path/from/../to/resource".

Specified by:

getPath in interface Resource

getUri

public URI getUri()

Description copied from interface: Resource

Returns a unique and complete identifier for this resource. This will be different than what is returned by Resource.getPath() because the path within the resource accessor whereas this is the a complete path to it.

For example, a file resource may return a path of my/file.txt and a uri of file:/tmp/project/liquibase/my/file.txt for a resource accessor using file:/tmp/project/liquibase as a root

Specified by:

getUri in interface Resource

isWritable

public boolean isWritable()

Description copied from interface: Resource

Return true if the resource can be written to

Specified by:

isWritable in interface Resource

openOutputStream

public OutputStream openOutputStream(boolean createIfNeeded)
                              throws IOException

Description copied from interface: Resource

Opens an output stream to write to this resource. Note that calling this method will truncate (erase) the existing file.

Specified by:

openOutputStream in interface Resource

Parameters:

createIfNeeded - if true, create the resource if it does not exist. If false, throw an exception if it does not exist

Throws:

IOException - if there is an error writing to the resource, including if the resource does not exist or permission don't allow writing.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

resolvePath

protected String resolvePath(String other)

Convenience method for computing the relative path in Resource.resolve(String) implementations

resolveSiblingPath

protected String resolveSiblingPath(String other)

Convenience method for computing the relative path in Resource.resolveSibling(String) implementations.