Top Fields Constructors Methods
liquibase.resource

public abstract Class AbstractResource

extends Object
implements Resource
Class Inheritance
All Implemented Interfaces
liquibase.resource.Resource
Known Direct Subclasses
liquibase.resource.PathResource, liquibase.resource.ResourceAccessor.NotFoundResource, liquibase.resource.URIResource, liquibase.sdk.resource.MockResource, liquibase.integration.spring.SpringResource
Imports
java.io.IOException, .OutputStream, java.net.URI

Field Summary

Modifier and TypeField and Description
private final String
private final URI

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String
getPath()

Implements liquibase.resource.Resource.getPath.

Returns the normalized, ResourceAccessor-relative path for this resource.

public URI
getUri()

Implements liquibase.resource.Resource.getUri.

Returns a unique and complete identifier for this resource.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isWritable()

Implements liquibase.resource.Resource.isWritable.

Return true if the resource can be written to

public OutputStream
openOutputStream(OpenOptions openOptions)

Implements liquibase.resource.Resource.openOutputStream.

Opens an output stream given the passed OpenOptions.

protected String
resolvePath(String other)

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

protected String
resolveSiblingPath(String other)

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

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

pathback to summary
private final String path
uriback to summary
private final URI uri

Constructor Detail

AbstractResourceback to summary
public AbstractResource(String path, URI uri)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getPathback to summary
public String getPath()

Implements liquibase.resource.Resource.getPath.

Doc from liquibase.resource.Resource.getPath.

Returns the normalized, ResourceAccessor-relative path for this resource. To get the unique location of this resource, use 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".

Annotations
@Override
getUriback to summary
public URI getUri()

Implements liquibase.resource.Resource.getUri.

Doc from liquibase.resource.Resource.getUri.

Returns a unique and complete identifier for this resource. This will be different than what is returned by 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

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isWritableback to summary
public boolean isWritable()

Implements liquibase.resource.Resource.isWritable.

Doc from liquibase.resource.Resource.isWritable.

Return true if the resource can be written to

Annotations
@Override
openOutputStreamback to summary
public OutputStream openOutputStream(OpenOptions openOptions) throws IOException

Implements liquibase.resource.Resource.openOutputStream.

Doc from liquibase.resource.Resource.openOutputStream.

Opens an output stream given the passed OpenOptions. Cannot pass a null OpenOptions value

Annotations
@Override
resolvePathback to summary
protected String resolvePath(String other)

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

resolveSiblingPathback to summary
protected String resolveSiblingPath(String other)

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

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override