Package org.flywaydb.core.api

Class Location

java.lang.Object

org.flywaydb.core.api.Location

All Implemented Interfaces:

Comparable<Location>

public final class Location
extends Object
implements Comparable<Location>

A location to load migrations from.

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILESYSTEM_PREFIX	The prefix for filesystem locations.

Constructor Summary

Constructors

Constructor	Description
Location(String descriptor)	Creates a new location.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Location o)
boolean	equals(Object o)
String	getDescriptor()
String	getPath()
String	getPrefix()
int	hashCode()
boolean	isClassPath()	Checks whether this denotes a location on the classpath.
boolean	isFileSystem()	Checks whether this denotes a location on the filesystem.
boolean	isParentOf(Location other)	Checks whether this location is a parent of this other location.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FILESYSTEM_PREFIX

public static final String FILESYSTEM_PREFIX

The prefix for filesystem locations.

See Also:

Constant Field Values

Constructor Detail

Location

public Location(String descriptor)

Creates a new location.

Parameters:

descriptor - The location descriptor.

Method Detail

isClassPath

public boolean isClassPath()

Checks whether this denotes a location on the classpath.

Returns:

true if it does, false if it doesn't.

isFileSystem

public boolean isFileSystem()

Checks whether this denotes a location on the filesystem.

Returns:

true if it does, false if it doesn't.

isParentOf

public boolean isParentOf(Location other)

Checks whether this location is a parent of this other location.

Parameters:

other - The other location.

Returns:

true if it is, false if it isn't.

getPrefix

public String getPrefix()

Returns:

The prefix part of the location. Can be either classpath: or filesystem:.

getPath

public String getPath()

Returns:

The path part of the location.

getDescriptor

public String getDescriptor()

Returns:

The complete location descriptor.

compareTo

public int compareTo(Location o)

Specified by:

compareTo in interface Comparable<Location>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

The complete location descriptor.