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

Go to download
/*
 * 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.Collection;
import java.util.Collections;

/**
 * Represents the result of some operations.
 *
 * @author Michael J. Simons
 * @since 1.1.0
 */
public interface OperationResult {

	/**
	 * @return all warnings, if any
	 */
	default Collection getWarnings() {
		return Collections.emptyList();
	}

	/**
	 * @return a sensible string applicable in a log or info message
	 */
	String prettyPrint();
}