org.springframework.data.relational.core.mapping.event.BeforeSaveEvent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-data-relational Show documentation

Spring Data Relational support

There is a newer version: 3.3.2

Show newest version

/*
 * Copyright 2017-2023 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 org.springframework.data.relational.core.mapping.event;

import org.springframework.data.relational.core.conversion.AggregateChange;

/**
 * Gets published before changes are applied to the database, after the aggregate was converted to a database change.
 * 
 * The persisting process works as follows:
 * 

 * A decision is made, if the aggregate is new and therefore should be inserted or if it is not new and therefore
 * should be updated.
 * {@link BeforeConvertCallback} and {@link BeforeConvertEvent} get published.
 * An {@link org.springframework.data.relational.core.conversion.AggregateChange} object is created for the
 * aggregate. It includes the {@link org.springframework.data.relational.core.conversion.DbAction} instances to be
 * executed. This means that all the deletes, updates and inserts to be performed are determined. These actions
 * reference entities of the aggregates in order to access values to be used in the SQL statements. This step also
 * determines if the id of an entity gets passed to the database or if the database is expected to generate that id.
 * {@link BeforeSaveCallback} and {@link BeforeSaveEvent} get published.
 * SQL statements get applied to the database.
 * {@link AfterSaveCallback} and {@link AfterSaveEvent} get published.
 * 
 *
 * @author Jens Schauder
 * @see BeforeSaveEvent
 */
public class BeforeSaveEvent extends RelationalSaveEvent {

	private static final long serialVersionUID = -4935804431519314116L;

	/**
	 * @param instance the entity about to get saved. Must not be {@literal null}.
	 * @param change the {@link AggregateChange} that is going to get applied to the database. Must not be
	 *          {@literal null}.
	 */
	public BeforeSaveEvent(E instance, AggregateChange change) {
		super(instance, change);
	}
}