io.evitadb.api.requestResponse.data.mutation.LocalMutationExecutor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of evita_api Show documentation
Show all versions of evita_api Show documentation
Module contains external API of the evitaDB.
/*
*
* _ _ ____ ____
* _____ _(_) |_ __ _| _ \| __ )
* / _ \ \ / / | __/ _` | | | | _ \
* | __/\ V /| | || (_| | |_| | |_) |
* \___| \_/ |_|\__\__,_|____/|____/
*
* Copyright (c) 2023-2024
*
* Licensed under the Business Source License, Version 1.1 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://github.com/FgForrest/evitaDB/blob/master/LICENSE
*
* 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 io.evitadb.api.requestResponse.data.mutation;
import javax.annotation.Nonnull;
import java.util.List;
/**
* Mutation executor applies local mutations on entity contents. Entity contents can be organized in different way than
* entity itself and may be more optimal for storage / reading / writing handling.
*
* @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2021
*/
public interface LocalMutationExecutor {
/**
* Method is called when {@link LocalMutation} is applied on entity instance.
*
* @param localMutation mutation to process
*/
void applyMutation(@Nonnull LocalMutation localMutation);
/**
* Method returns and clears list of implicit mutations that needs to be executed to keep entity consistent.
* These implicit mutations usually represent initialization of default values on entity creation.
*
* @return list of implicit mutations
*/
@Nonnull
List> popImplicitMutations();
/**
* Method allows to apply all changes that has been recorded by this executor during multiple execution of
* {@link #applyMutation(LocalMutation)}. The method is called only once after all mutations has been applied.
*/
void commit();
/**
* Rolls back all changes that has been recorded by this executor during multiple execution of
* {@link #applyMutation(LocalMutation)}. The method is called only once before the executor is thrown out.
*/
void rollback();
}