Module org.eclipse.jgit
Package org.eclipse.jgit.api

Class PushCommand

java.lang.Object
org.eclipse.jgit.api.GitCommand<T>
org.eclipse.jgit.api.TransportCommand<PushCommand,Iterable<PushResult>>
org.eclipse.jgit.api.PushCommand
All Implemented Interfaces:
Callable<Iterable<PushResult>>
public class PushCommand extends TransportCommand<PushCommand,Iterable<PushResult>>
A class used to execute a Push command. It has setters for all supported options and arguments of this command and a call() method to finally execute the command.
See Also:

  • Constructor Details

    • PushCommand

      protected PushCommand(Repository repo)

      Constructor for PushCommand.

      Parameters:
      repo - the Repository

  • Method Details

    • call

      public Iterable<PushResult> call() throws GitAPIException, InvalidRemoteException, TransportException

      Execute the command

      Execute the push command with all the options and parameters collected by the setter methods of this class. Each instance of this class should only be used for one invocation of the command (means: one call to call())

      Specified by:
      call in interface Callable<Iterable<PushResult>>
      Specified by:
      call in class GitCommand<Iterable<PushResult>>
      Throws:
      GitAPIException
      InvalidRemoteException
      TransportException

    • setRemote

      public PushCommand setRemote(String remote)
      The remote (uri or name) used for the push operation. If no remote is set, the default value of Constants.DEFAULT_REMOTE_NAME will be used.
      Parameters:
      remote - the remote name
      Returns:
      this
      See Also:

    • getRemote

      public String getRemote()
      Get remote name
      Returns:
      the remote used for the remote operation

    • setHookOutputStream

      public PushCommand setHookOutputStream(PrintStream redirect)
      Sets a PrintStream a "pre-push" hook may write its stdout to. If not set, System.out will be used.

      When pushing to several remote repositories the stream is shared for all pushes.

      Parameters:
      redirect - PrintStream to use; if null, System.out will be used
      Returns:
      this
      Since:
      6.4

    • setHookErrorStream

      public PushCommand setHookErrorStream(PrintStream redirect)
      Sets a PrintStream a "pre-push" hook may write its stderr to. If not set, System.err will be used.

      When pushing to several remote repositories the stream is shared for all pushes.

      Parameters:
      redirect - PrintStream to use; if null, System.err will be used
      Returns:
      this
      Since:
      6.4

    • setReceivePack

      public PushCommand setReceivePack(String receivePack)
      The remote executable providing receive-pack service for pack transports. If no receive-pack is set, the default value of RemoteConfig.DEFAULT_RECEIVE_PACK will be used.
      Parameters:
      receivePack - name of the remote executable providing the receive-pack service
      Returns:
      this
      See Also:

    • getReceivePack

      public String getReceivePack()
      Get the name of the remote executable providing the receive-pack service
      Returns:
      the receive-pack used for the remote operation

    • getTimeout

      public int getTimeout()
      Get timeout used for push operation
      Returns:
      the timeout used for the push operation

    • getProgressMonitor

      public ProgressMonitor getProgressMonitor()
      Get the progress monitor
      Returns:
      the progress monitor for the push operation

    • setProgressMonitor

      public PushCommand setProgressMonitor(ProgressMonitor monitor)
      The progress monitor associated with the push operation. By default, this is set to NullProgressMonitor
      Parameters:
      monitor - a ProgressMonitor
      Returns:
      this
      See Also:

    • getRefLeaseSpecs

      public List<RefLeaseSpec> getRefLeaseSpecs()
      Get the RefLeaseSpecs.
      Returns:
      the RefLeaseSpecs
      Since:
      4.7

    • setRefLeaseSpecs

      public PushCommand setRefLeaseSpecs(RefLeaseSpec... specs)
      The ref lease specs to be used in the push operation, for a force-with-lease push operation.
      Parameters:
      specs - a RefLeaseSpec object.
      Returns:
      this
      Since:
      4.7

    • setRefLeaseSpecs

      public PushCommand setRefLeaseSpecs(List<RefLeaseSpec> specs)
      The ref lease specs to be used in the push operation, for a force-with-lease push operation.
      Parameters:
      specs - list of RefLeaseSpecs
      Returns:
      this
      Since:
      4.7

    • getRefSpecs

      public List<RefSpec> getRefSpecs()
      Get RefSpecs.
      Returns:
      the ref specs

    • setRefSpecs

      public PushCommand setRefSpecs(RefSpec... specs)
      The ref specs to be used in the push operation
      Parameters:
      specs - a RefSpec object.
      Returns:
      this

    • setRefSpecs

      public PushCommand setRefSpecs(List<RefSpec> specs)
      The ref specs to be used in the push operation
      Parameters:
      specs - list of RefSpecs
      Returns:
      this

    • getPushDefault

      public PushConfig.PushDefault getPushDefault()
      Retrieves the PushConfig.PushDefault currently set.
      Returns:
      the PushConfig.PushDefault, or null if not set
      Since:
      6.1

    • setPushDefault

      public PushCommand setPushDefault(PushConfig.PushDefault pushDefault)
      Sets an explicit PushConfig.PushDefault. The default used if this is not called is PushConfig.PushDefault.CURRENT for compatibility reasons with earlier JGit versions.
      Parameters:
      pushDefault - PushConfig.PushDefault to set; if null the value defined in the git config will be used.
      Returns:
      this
      Since:
      6.1

    • setPushAll

      public PushCommand setPushAll()
      Push all branches under refs/heads/*.
      Returns:
      this

    • setPushTags

      public PushCommand setPushTags()
      Push all tags under refs/tags/*.
      Returns:
      this

    • add

      public PushCommand add(Ref ref)
      Add a reference to push.
      Parameters:
      ref - the source reference. The remote name will match.
      Returns:
      this.

    • add

      public PushCommand add(String nameOrSpec)
      Add a reference to push.
      Parameters:
      nameOrSpec - any reference name, or a reference specification.
      Returns:
      this.
      Throws:
      JGitInternalException - the reference name cannot be resolved.

    • isDryRun

      public boolean isDryRun()
      Whether to run the push operation as a dry run
      Returns:
      the dry run preference for the push operation

    • setDryRun

      public PushCommand setDryRun(boolean dryRun)
      Sets whether the push operation should be a dry run
      Parameters:
      dryRun - a boolean.
      Returns:
      this

    • isThin

      public boolean isThin()
      Get the thin-pack preference
      Returns:
      the thin-pack preference for push operation

    • setThin

      public PushCommand setThin(boolean thinPack)
      Set the thin-pack preference for push operation. Default setting is Transport.DEFAULT_PUSH_THIN
      Parameters:
      thinPack - the thin-pack preference value
      Returns:
      this

    • isUseBitmaps

      public boolean isUseBitmaps()
      Whether to use bitmaps for push.
      Returns:
      true if push use bitmaps.
      Since:
      6.4

    • setUseBitmaps

      public PushCommand setUseBitmaps(boolean useBitmaps)
      Set whether to use bitmaps for push. Default setting is true
      Parameters:
      useBitmaps - false to disable use of bitmaps for push, true otherwise.
      Returns:
      this
      Since:
      6.4

    • isAtomic

      public boolean isAtomic()
      Whether this push should be executed atomically (all references updated, or none)
      Returns:
      true if all-or-nothing behavior is requested.
      Since:
      4.2

    • setAtomic

      public PushCommand setAtomic(boolean atomic)
      Requests atomic push (all references updated, or no updates). Default setting is false.
      Parameters:
      atomic - whether to run the push atomically
      Returns:
      this
      Since:
      4.2

    • isForce

      public boolean isForce()
      Whether to push forcefully
      Returns:
      the force preference for push operation

    • setForce

      public PushCommand setForce(boolean force)
      Sets the force preference for push operation.
      Parameters:
      force - whether to push forcefully
      Returns:
      this

    • setOutputStream

      public PushCommand setOutputStream(OutputStream out)
      Sets the output stream to write sideband messages to
      Parameters:
      out - an OutputStream
      Returns:
      this
      Since:
      3.0

    • getPushOptions

      public List<String> getPushOptions()
      Get push options
      Returns:
      the option strings associated with the push operation
      Since:
      4.5

    • setPushOptions

      public PushCommand setPushOptions(List<String> pushOptions)
      Set the option strings associated with the push operation.
      Parameters:
      pushOptions - a List of push option strings
      Returns:
      this
      Since:
      4.5