liquibase.resource

Class PathResource

java.lang.Object

liquibase.resource.AbstractResource

liquibase.resource.PathResource

All Implemented Interfaces:

Resource

public class PathResource
extends AbstractResource

Constructor Summary

Constructors

Constructor and Description
PathResource(String logicalPath, Path path)

Method Summary

Modifier and Type	Method and Description
boolean	exists()
boolean	isWritable() Return true if the resource can be written to
InputStream	openInputStream() Opens an input stream to read from this resource.
OutputStream	openOutputStream(boolean createIfNeeded) Opens an output stream to write to this resource.
Resource	resolve(String other) Resolve the given path against this resource.
Resource	resolveSibling(String other) Resolves the given path against this resource's parent path.

Methods inherited from class liquibase.resource.AbstractResource

equals, getPath, getUri, hashCode, resolvePath, resolveSiblingPath, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PathResource

public PathResource(String logicalPath,
                    Path path)

Method Detail

openInputStream

public InputStream openInputStream()
                            throws IOException

Description copied from interface: Resource

Opens an input stream to read from this resource.

Throws:

IOException - if there is an error reading from the resource, including if the resource does not exist or cannot be read.

exists

public boolean exists()

Returns:

true if the resource defined by this object currently exists.

resolve

public Resource resolve(String other)

Description copied from interface: Resource

Resolve the given path against this resource. If other is an empty path then this method trivially returns this path. Otherwise this method considers this resource to be a directory and resolves the given path against this resource. Even if "other" begins with a `/`, the returned resource should be relative to this resource.

resolveSibling

public Resource resolveSibling(String other)

Description copied from interface: Resource

Resolves the given path against this resource's parent path. This is useful where a file name needs to be replaced with another file name. For example, suppose that the name separator is "/" and a path represents "dir1/dir2/foo", then invoking this method with the Path "bar" will result in the Path "dir1/dir2/bar". If other is an empty path then this method returns this path's parent. Even if "other" begins with a `/`, the returned resource should be relative to this 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

Overrides:

isWritable in class AbstractResource

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

Overrides:

openOutputStream in class AbstractResource

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.