diff options
Diffstat (limited to 'gerrit-server/src/main/java/com/google/gerrit/server/update/Context.java')
-rw-r--r-- | gerrit-server/src/main/java/com/google/gerrit/server/update/Context.java | 140 |
1 files changed, 0 insertions, 140 deletions
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/update/Context.java b/gerrit-server/src/main/java/com/google/gerrit/server/update/Context.java deleted file mode 100644 index f33536d167..0000000000 --- a/gerrit-server/src/main/java/com/google/gerrit/server/update/Context.java +++ /dev/null @@ -1,140 +0,0 @@ -// 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.Account; -import com.google.gerrit.reviewdb.client.Project; -import com.google.gerrit.reviewdb.server.ReviewDb; -import com.google.gerrit.server.CurrentUser; -import com.google.gerrit.server.IdentifiedUser; -import java.io.IOException; -import java.sql.Timestamp; -import java.util.TimeZone; -import org.eclipse.jgit.revwalk.RevWalk; - -/** - * Context for performing a {@link BatchUpdate}. - * - * <p>A single update may span multiple changes, but they all belong to a single repo. - */ -public interface Context { - /** - * Get the project name this update operates on. - * - * @return project. - */ - Project.NameKey getProject(); - - /** - * Get a read-only view of the open repository for this project. - * - * <p>Will be opened lazily if necessary. - * - * @return repository instance. - * @throws IOException if an error occurred opening the repo. - */ - RepoView getRepoView() throws IOException; - - /** - * Get a walk for this project. - * - * <p>The repository will be opened lazily if necessary; callers should not close the walk. - * - * @return walk. - * @throws IOException if an error occurred opening the repo. - */ - RevWalk getRevWalk() throws IOException; - - /** - * Get the timestamp at which this update takes place. - * - * @return timestamp. - */ - Timestamp getWhen(); - - /** - * Get the time zone in which this update takes place. - * - * <p>In the current implementation, this is always the time zone of the server. - * - * @return time zone. - */ - TimeZone getTimeZone(); - - /** - * Get the ReviewDb database. - * - * <p>Callers should not manage transactions or call mutating methods on the Changes table. - * Mutations on other tables (including other entities in the change entity group) are fine. - * - * @return open database instance. - */ - ReviewDb getDb(); - - /** - * Get the user performing the update. - * - * <p>In the current implementation, this is always an {@link IdentifiedUser} or {@link - * com.google.gerrit.server.InternalUser}. - * - * @return user. - */ - CurrentUser getUser(); - - /** - * Get the order in which operations are executed in this update. - * - * @return order of operations. - */ - Order getOrder(); - - /** - * Get the identified user performing the update. - * - * <p>Convenience method for {@code getUser().asIdentifiedUser()}. - * - * @see CurrentUser#asIdentifiedUser() - * @return user. - */ - default IdentifiedUser getIdentifiedUser() { - return checkNotNull(getUser()).asIdentifiedUser(); - } - - /** - * Get the account of the user performing the update. - * - * <p>Convenience method for {@code getIdentifiedUser().getAccount()}. - * - * @see CurrentUser#asIdentifiedUser() - * @return account. - */ - default Account getAccount() { - return getIdentifiedUser().getAccount(); - } - - /** - * Get the account ID of the user performing the update. - * - * <p>Convenience method for {@code getUser().getAccountId()} - * - * @see CurrentUser#getAccountId() - * @return account ID. - */ - default Account.Id getAccountId() { - return getIdentifiedUser().getAccountId(); - } -} |