Interface Context

  • All Known Subinterfaces:
    ChangeContext, RepoContext

    public interface Context
    Context for performing a BatchUpdate.

    A single update may span multiple changes, but they all belong to a single repo.

    • 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

        Timestamp getWhen()
        Get the timestamp at which this update takes place.
        Returns:
        timestamp.
      • getTimeZone

        TimeZone getTimeZone()
        Get the time zone in which this update takes place.

        In the current implementation, this is always the time zone of the server.

        Returns:
        time zone.
      • 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()