com.google.gerrit.server.update.ChangeContext Maven / Gradle / Ivy
// Copyright (C) 2017 The Android Open Source Project
//
// 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
//
// http://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 com.google.gerrit.server.update;
import static com.google.common.base.Preconditions.checkNotNull;
import com.google.gerrit.reviewdb.client.Change;
import com.google.gerrit.reviewdb.client.PatchSet;
import com.google.gerrit.server.notedb.ChangeNotes;
import com.google.gerrit.server.notedb.ChangeUpdate;
import com.google.gerrit.server.project.ChangeControl;
/**
* Context for performing the {@link BatchUpdateOp#updateChange} phase.
*
* A single {@code ChangeContext} corresponds to updating a single change; if a {@link
* BatchUpdate} spans multiple changes, then multiple {@code ChangeContext} instances will be
* created.
*/
public interface ChangeContext extends Context {
/**
* Get an update for this change at a given patch set.
*
*
A single operation can modify changes at different patch sets. Commits in the NoteDb graph
* within this update are created in patch set order.
*
*
To get the current patch set ID, use {@link com.google.gerrit.server.PatchSetUtil#current}.
*
* @param psId patch set ID.
* @return handle for change updates.
*/
ChangeUpdate getUpdate(PatchSet.Id psId);
/**
* @return control for this change. The user will be the same as {@link #getUser()}, and the
* change data is read within the same transaction that {@code updateChange} is executing.
*/
ChangeControl getControl();
/**
* @param bump whether to bump the value of {@link Change#getLastUpdatedOn()} field before storing
* to ReviewDb. For NoteDb, the value is always incremented (assuming the update is not
* otherwise a no-op).
*/
void bumpLastUpdatedOn(boolean bump);
/**
* Instruct {@link BatchUpdate} to delete this change.
*
*
If called, all other updates are ignored.
*/
void deleteChange();
/** @return notes corresponding to {@link #getControl()}. */
default ChangeNotes getNotes() {
return checkNotNull(getControl().getNotes());
}
/** @return change corresponding to {@link #getControl()}. */
default Change getChange() {
return checkNotNull(getControl().getChange());
}
}