Package com.google.gerrit.server.update
Interface Context
-
- All Known Subinterfaces:
ChangeContext
,PostUpdateContext
,RepoContext
public interface Context
Context for performing aBatchUpdate
.A single update may span multiple changes, but they all belong to a single repo.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default AccountState
getAccount()
Get the account of the user performing the update.default Account.Id
getAccountId()
Get the account ID of the user performing the update.default IdentifiedUser
getIdentifiedUser()
Get the identified user performing the update.NotifyResolver.Result
getNotify(Change.Id changeId)
Get the notification settings configured by the caller.Project.NameKey
getProject()
Get the project name this update operates on.RepoView
getRepoView()
Get a read-only view of the open repository for this project.org.eclipse.jgit.revwalk.RevWalk
getRevWalk()
Get a walk for this project.CurrentUser
getUser()
Get the user performing the update.Instant
getWhen()
Get the timestamp at which this update takes place.ZoneId
getZoneId()
Get the time zone ID in which this update takes place.default org.eclipse.jgit.lib.PersonIdent
newCommitterIdent()
Creates a committerPersonIdent
forgetIdentifiedUser()
.default org.eclipse.jgit.lib.PersonIdent
newCommitterIdent(IdentifiedUser user)
Creates a committerPersonIdent
for the given user.default org.eclipse.jgit.lib.PersonIdent
newPersonIdent(org.eclipse.jgit.lib.PersonIdent personIdent)
Creates a newPersonIdent
withgetWhen()
as timestamp.
-
-
-
Method Detail
-
getProject
Project.NameKey getProject()
Get the project name this update operates on.- Returns:
- project.
-
getRepoView
RepoView getRepoView() throws IOException
Get a read-only view of the open repository for this project.Will be opened lazily if necessary.
- Returns:
- repository instance.
- Throws:
IOException
- if an error occurred opening the repo.
-
getRevWalk
org.eclipse.jgit.revwalk.RevWalk getRevWalk() throws IOException
Get a walk for this project.The repository will be opened lazily if necessary; callers should not close the walk.
- Returns:
- walk.
- Throws:
IOException
- if an error occurred opening the repo.
-
getWhen
Instant getWhen()
Get the timestamp at which this update takes place.- Returns:
- timestamp.
-
getZoneId
ZoneId getZoneId()
Get the time zone ID in which this update takes place.In the current implementation, this is always the time zone ID of the server.
- Returns:
- zone ID.
-
getUser
CurrentUser getUser()
Get the user performing the update.In the current implementation, this is always an
IdentifiedUser
orInternalUser
.- Returns:
- user.
-
getNotify
NotifyResolver.Result getNotify(Change.Id changeId)
Get the notification settings configured by the caller.If there are multiple changes in a batch, they may have different settings. For example, WIP changes may have reduced
NotifyHandling
levels, and may be in a batch with non-WIP changes.- Parameters:
changeId
- change ID- Returns:
- notification settings.
-
getIdentifiedUser
default IdentifiedUser getIdentifiedUser()
Get the identified user performing the update.Convenience method for
getUser().asIdentifiedUser()
.- Returns:
- user.
- See Also:
CurrentUser.asIdentifiedUser()
-
getAccount
default AccountState getAccount()
Get the account of the user performing the update.Convenience method for
getIdentifiedUser().account()
.- Returns:
- account.
- See Also:
CurrentUser.asIdentifiedUser()
-
getAccountId
default Account.Id getAccountId()
Get the account ID of the user performing the update.Convenience method for
getUser().getAccountId()
- Returns:
- account ID.
- See Also:
CurrentUser.getAccountId()
-
newPersonIdent
default org.eclipse.jgit.lib.PersonIdent newPersonIdent(org.eclipse.jgit.lib.PersonIdent personIdent)
Creates a newPersonIdent
withgetWhen()
as timestamp.- Parameters:
personIdent
-PersonIdent
to be copied- Returns:
- copied
PersonIdent
withgetWhen()
as timestamp
-
newCommitterIdent
default org.eclipse.jgit.lib.PersonIdent newCommitterIdent()
Creates a committerPersonIdent
forgetIdentifiedUser()
.- Returns:
- the created committer
PersonIdent
-
newCommitterIdent
default org.eclipse.jgit.lib.PersonIdent newCommitterIdent(IdentifiedUser user)
Creates a committerPersonIdent
for the given user.- Parameters:
user
- user for which a committerPersonIdent
should be created- Returns:
- the created committer
PersonIdent
-
-