Package ac.simons.neo4j.migrations.core

Class AbstractResourceBasedMigrationProvider

java.lang.Object

ac.simons.neo4j.migrations.core.AbstractResourceBasedMigrationProvider

All Implemented Interfaces:

Ordered, ResourceBasedMigrationProvider

public abstract class AbstractResourceBasedMigrationProvider
extends Object
implements ResourceBasedMigrationProvider

A utility class to avoid duplication of common characteristics of migration providers.

Since:

1.9.0

Author:

Michael J. Simons

Field Summary

Fields inherited from interface ac.simons.neo4j.migrations.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractResourceBasedMigrationProvider(int order, String extension, boolean supportsArbitraryResourceNames)	The given parameters are all required.

Method Summary

Modifier and Type	Method	Description
final String	getExtension()
final int	getOrder()
final boolean	supportsArbitraryResourceNames()	Return true if the provider has different ways how to map from file / resource names to a valid version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ac.simons.neo4j.migrations.core.ResourceBasedMigrationProvider

handle

Constructor Details

AbstractResourceBasedMigrationProvider

protected AbstractResourceBasedMigrationProvider(int order,
 String extension,
 boolean supportsArbitraryResourceNames)

The given parameters are all required.

Parameters:

order - The order in which this provider should be consulted

extension - The file extension that this provider can deal with

supportsArbitraryResourceNames - A flag if arbitrary resource names are supported in contrast to names that match MigrationVersion.VERSION_PATTERN

Method Details

getOrder

public final int getOrder()

Specified by:

getOrder in interface Ordered

Returns:

the order value of this object.

getExtension

public final String getExtension()

Specified by:

getExtension in interface ResourceBasedMigrationProvider

Returns:

the file extension this resource based migration provider deals with

supportsArbitraryResourceNames

public final boolean supportsArbitraryResourceNames()

Description copied from interface: ResourceBasedMigrationProvider

Return true if the provider has different ways how to map from file / resource names to a valid version.

Specified by:

supportsArbitraryResourceNames in interface ResourceBasedMigrationProvider

Returns:

true if this provider can deal with non versioned file names