org.eclipse.jgit.api
Class StatusCommand

java.lang.Object
  extended by org.eclipse.jgit.api.GitCommand<Status>
      extended by org.eclipse.jgit.api.StatusCommand
All Implemented Interfaces:
Callable<Status>

public class StatusCommand
extends GitCommand<Status>

A class used to execute a Status command. It has setters for all supported options and arguments of this command and a call() method to finally execute the command. Each instance of this class should only be used for one invocation of the command (means: one call to call())

See Also:
Git documentation about Status

Field Summary
 
Fields inherited from class org.eclipse.jgit.api.GitCommand
repo
 
Constructor Summary
protected StatusCommand(Repository repo)
           
 
Method Summary
 Status call()
          Executes the Status command with all the options and parameters collected by the setter methods of this class.
 void setWorkingTreeIt(WorkingTreeIterator workingTreeIt)
          To set the WorkingTreeIterator which should be used.
 
Methods inherited from class org.eclipse.jgit.api.GitCommand
checkCallable, getRepository, setCallable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StatusCommand

protected StatusCommand(Repository repo)
Parameters:
repo -
Method Detail

call

public Status call()
            throws IOException,
                   NoWorkTreeException
Executes the Status 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. Don't call this method twice on an instance.

Returns:
a Status object telling about each path where working tree, index or HEAD differ from each other.
Throws:
IOException
NoWorkTreeException

setWorkingTreeIt

public void setWorkingTreeIt(WorkingTreeIterator workingTreeIt)
To set the WorkingTreeIterator which should be used. If this method is not called a standard FileTreeIterator is used.

Parameters:
workingTreeIt -


Copyright © 2011. All Rights Reserved.