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 Details

    • FILESYSTEM_PREFIX

      public static final String FILESYSTEM_PREFIX
      The prefix for filesystem locations.
      See Also:

  • Constructor Details

    • Location

      public Location(String descriptor)

  • Method Details

    • matchesPath

      public boolean matchesPath(String path)
      Returns:
      Whether the given path matches this locations regex. Will always return true when the location did not contain any wildcards.

    • getPathRelativeToThis

      public String getPathRelativeToThis(String path)
      Returns the path relative to this location. If the location path contains wildcards, the returned path will be relative to the last non-wildcard folder in the path.

    • 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.

    • isAwsS3

      public boolean isAwsS3()
      Checks whether this denotes a location in AWS S3.
      Returns:
      true if it does, false if it doesn't;

    • isGCS

      public boolean isGCS()
      Checks whether this denotes a location in Google cloud storage.
      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.

    • 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.

    • getPrefix

      public String getPrefix()
      Returns:
      The prefix part of the location. Can be either classpath: or filesystem:.

    • getRootPath

      public String getRootPath()
      The first folder in the path. This will equal rawPath if the path does not contain any wildcards
      Returns:
      The root part of the path part of the location.

    • getPathRegex

      public Pattern getPathRegex()
      Returns:
      The regex that matches wildcards in the original path. Null if the original path did not contain any wildcards.