Module org.jooq

Package org.jooq

Interface Commits

All Superinterfaces:

Iterable<Commit>

public interface Commits
extends Iterable<Commit>

A (sub) set of commits.

This type is used to group together a set of commits that form a subgraph of the complete commit graph. Like the complete graph, this subgraph will have a single root() node.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
@NotNull Commits	add(Commit commit)	Add a commit to the graph.
@NotNull Commits	addAll(Collection<? extends Commit> commits)	Add all commits to the graph.
@NotNull Commits	addAll(Commit... commits)	Add all commits to the graph.
@NotNull Commit	current()	The current node.
@NotNull MigrationsType	export()	Export XML content from this commits graph.
@Nullable Commit	get(String id)	Get a commit from the graph by Node.id() or Tag.id()
@NotNull Commit	latest()	The latest node.
@NotNull Commits	load(File directory)	Load directory content into this commits graph.
@NotNull Commits	load(MigrationsType migrations)	Load XML content into this commits graph.
@NotNull Commit	root()	The root node.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

root

@NotNull
@NotNull Commit root()

The root node.

current

@NotNull
@NotNull Commit current()
                 throws DataMigrationVerificationException

The current node.

The current node is the node in the graph that has been installed in the database.

Throws:

DataMigrationVerificationException - In case there's no current node in the database, which can happen e.g. when no migration has been initialised yet, or when the currently installed Node.id() is not part of this graph.

latest

@NotNull
@NotNull Commit latest()
                throws DataMigrationVerificationException

The latest node.

The latest node is the last node in the graph, if all branches have been merged successfully, or the latest node of the default branch, in case a default branch has been specified.

Throws:

DataMigrationVerificationException - In case there's no latest node, i.e. there's no default branch and branches haven't all been merged yet.

get

@Nullable
@Nullable Commit get(String id)

Get a commit from the graph by Node.id() or Tag.id()

Returns:

The resulting Commit, or null, if the ID was not found.

add

@NotNull
@NotNull Commits add(Commit commit)

Add a commit to the graph.

Returns:

The same instance.

addAll

@NotNull
@NotNull Commits addAll(Commit... commits)

Add all commits to the graph.

Returns:

The same instance.

addAll

@NotNull
@NotNull Commits addAll(Collection<? extends Commit> commits)

Add all commits to the graph.

Returns:

The same instance.

load

@NotNull
@NotNull Commits load(File directory)
               throws IOException,
DataMigrationVerificationException

Load directory content into this commits graph.

Returns:

The same instance.

Throws:

IOException - If anything goes wrong reading the directory contents.

DataMigrationVerificationException - If the migration verification fails.

load

@NotNull
@NotNull Commits load(MigrationsType migrations)
               throws DataMigrationVerificationException

Load XML content into this commits graph.

Returns:

The same instance.

Throws:

DataMigrationVerificationException - If the migration verification fails.

export

@NotNull
@NotNull MigrationsType export()

Export XML content from this commits graph.