org.jooq.RecordContext Maven / Gradle / Ivy
/*
* 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.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* ASL 2.0 and offer limited warranties, support, maintenance, and commercial
* database integrations.
*
* For more information, please visit: https://www.jooq.org/legal/licensing
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* A context object for {@link Record} manipulation passed to registered
* {@link RecordListener}'s.
*
* This type is a {@link Scope} with independent lifecycle and its own
* {@link #data()} map.
*
* @author Lukas Eder
*/
public interface RecordContext extends Scope {
/**
* The type of database interaction that is being executed.
*
* Unlike {@link ExecuteContext#type()}, this can only result in any of
* these:
*
* - {@link ExecuteType#BATCH} when calling
* {@link DSLContext#batchStore(UpdatableRecord...) batchStore()},
* {@link DSLContext#batchInsert(TableRecord...) batchInsert()},
* {@link DSLContext#batchUpdate(UpdatableRecord...) batchUpdate()},
* {@link DSLContext#batchDelete(UpdatableRecord...) batchDelete()}.
* - {@link ExecuteType#READ} when calling
* {@link UpdatableRecord#refresh() refresh()}
* - {@link ExecuteType#WRITE} when calling
* {@link UpdatableRecord#store() store()}, {@link UpdatableRecord#insert()
* insert()}, {@link UpdatableRecord#update() update()},
* {@link UpdatableRecord#delete() delete()}.
*
*
* @see ExecuteType
*/
@NotNull
ExecuteType type();
/**
* The Record that is being manipulated.
*
* @return The Record being manipulated. This is never
* null
*/
@NotNull
Record record();
/**
* The RecordType of the {@link #record()} that is being
* manipulated.
*
* @return The RecordType being manipulated. This is never
* null.
*/
@NotNull
RecordType recordType();
/**
* The Record(s) that are being manipulated in batch mode.
*
* If a single Record is being manipulated in non-batch mode,
* this will return an array of length 1, containing that
* Record.
*
* @return The Record(s) being manipulated. This is never
* null
*/
@NotNull
Record @NotNull [] batchRecords();
/**
* The {@link Exception} being thrown or null.
*/
@Nullable
Exception exception();
}