ac.simons.neo4j.migrations.core.Callback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-migrations Show documentation

The Core API of Neo4j-Migrations.

There is a newer version: 2.15.1

/*
 * Copyright 2020-2022 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package ac.simons.neo4j.migrations.core;

import java.util.Optional;

/**
 * Default contract for callbacks that might be involved during various phases of the migration lifecycle.
 * This interface might become public as soon as neo4j-migrations supports Java-based callbacks, too.
 *
 * @author Michael J. Simons
 * @since 1.2.2
 */
interface Callback {

	/**
	 * @return the phase in which to invoke this callback
	 */
	LifecyclePhase getPhase();

	/**
	 * If the description is empty, then callbacks in the same {@link LifecyclePhase lifecycle phase} won't be ordered.
	 * Otherwise, the description might be used to order callbacks in the same phase.
	 *
	 * @return an optional description
	 */
	Optional getOptionalDescription();

	/**
	 * @return Something that describes the source of this callback.
	 */
	String getSource();

	/**
	 * Invokes this callback with the given context
	 *
	 * @param event The event that happened
	 */
	void on(LifecycleEvent event);
}