net.ozwolf.mongo.migrations

Class MongoTrekState

java.lang.Object

net.ozwolf.mongo.migrations.MongoTrekState

public class MongoTrekState
extends Object

Mongo Trek State

This class provides the collection of migrations and an ability to query the overall state of the process.

This includes what the current version is, what the pending state is as well as a list of failed and applied migrations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MongoTrekState.Pending Migrations State - Pending State

Constructor Summary

Constructors

Constructor and Description
MongoTrekState(Collection<net.ozwolf.mongo.migrations.internal.domain.Migration> migrations)

Method Summary

Modifier and Type	Method and Description
List<net.ozwolf.mongo.migrations.internal.domain.Migration>	getApplied() Get the list of successfully applied migrations
String	getCurrentVersion() Get the currently applied migration version.
List<net.ozwolf.mongo.migrations.internal.domain.Migration>	getFailed() Get the list of migrations that have failed.
List<net.ozwolf.mongo.migrations.internal.domain.Migration>	getMigrations() Get the full list of migrations.
MongoTrekState.Pending	getPending() Return the pending migrations state.

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoTrekState

public MongoTrekState(Collection<net.ozwolf.mongo.migrations.internal.domain.Migration> migrations)

Method Detail

getCurrentVersion

public String getCurrentVersion()

Get the currently applied migration version.

Returns:

The currently applied version

getMigrations

public List<net.ozwolf.mongo.migrations.internal.domain.Migration> getMigrations()

Get the full list of migrations. This includes the entire history of applied migrations, even if the command source has since been removed from the project.

Returns:

The full list of migrations, both applied history and pending commands.

getPending

public MongoTrekState.Pending getPending()

Return the pending migrations state.

Returns:

The pending migration state

getFailed

public List<net.ozwolf.mongo.migrations.internal.domain.Migration> getFailed()

Get the list of migrations that have failed.

Returns:

The failed migrations

getApplied

public List<net.ozwolf.mongo.migrations.internal.domain.Migration> getApplied()

Get the list of successfully applied migrations

Returns:

The applied migrations