JGit 7.2.0.202503040940-r · org.eclipse.jgit.api.AddCommand

Modifier and Type	Field and Description
private Boolean	all
private List<String>	filepatterns
private boolean	renormalize
private boolean	update
private WorkingTreeIterator	workingTreeIterator

Access	Constructor and Description
public	AddCommand(Repository the `org.eclipse.jgit.lib.Repository` repo) Constructor for AddCommand

Method Summary

Modifier and Type	Method and Description
public AddCommand	Returns: `this` addFilepattern(String repository-relative path of file/directory to add (with `/` as separator) filepattern) Add a path to a file/directory whose content should be added.
public DirCache	call() Implements abstract org.eclipse.jgit.api.GitCommand.call. Implements java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so.
public boolean	Returns: `true` if it was set; `false` otherwise isAll() Tells whether '--all' has been set for this command.
public boolean	Returns: whether files will be renormalized isRenormalize() Tells whether the command will renormalize by re-applying the "clean" process to tracked files.
public boolean	Returns: whether to only match against already tracked files isUpdate() Whether to only match against already tracked files
public AddCommand	Returns: `this` setAll(boolean whether to enable '--all' mode all) Defines whether the command will use '--all' mode: update existing index entries, add new entries, and remove index entries for which there is no file.
public AddCommand	Returns: `this` setRenormalize(boolean whether to renormalize tracked files renormalize) Defines whether the command will renormalize by re-applying the "clean" process to tracked files.
public AddCommand	Returns: `this` setUpdate(boolean If set to true, the command only matches `filepattern` against already tracked files in the index rather than the working tree. That means that it will never stage new files, but that it will stage modified new contents of tracked files and that it will remove files from the index if the corresponding files in the working tree have been removed. In contrast to the git command line a `filepattern` must exist also if update is set to true as there is no concept of a working directory here. update) Set whether to only match against already tracked files.
public AddCommand	Returns: `this` setWorkingTreeIterator(WorkingTreeIterator a `org.eclipse.jgit.treewalk.WorkingTreeIterator` object. f) Allow clients to provide their own implementation of a FileTreeIterator

Inherited from org.eclipse.jgit.api.GitCommand:: checkCallable getRepository setCallable

all	back to summary
private Boolean all

filepatterns	back to summary
private List<String> filepatterns

renormalize	back to summary
private boolean renormalize

update	back to summary
private boolean update

workingTreeIterator	back to summary
private WorkingTreeIterator workingTreeIterator

AddCommand	back to summary
public AddCommand(Repository repo) Constructor for AddCommand Parameters repo:Repository the `org.eclipse.jgit.lib.Repository`

Method Detail

addFilepattern back to summary

addFilepattern	back to summary
public AddCommand addFilepattern(String filepattern) Add a path to a file/directory whose content should be added. A directory name (e.g. `dir` to add `dir/file1` and `dir/file2`) can also be given to add all files in the directory, recursively. Fileglobs (e.g. *.c) are not yet supported. If a pattern `"."` is added, all changes in the git repository's working tree will be added. File patterns are required unless `isUpdate() == true` or `setAll(boolean)` is called. If so and no file patterns are given, all changes will be added (i.e., a file pattern of `"."` is implied). Parameters filepattern:String repository-relative path of file/directory to add (with `/` as separator) Returns:AddCommand `this`

public AddCommand addFilepattern(String filepattern)

Add a path to a file/directory whose content should be added.

A directory name (e.g. dir to add dir/file1 and dir/file2) can also be given to add all files in the directory, recursively. Fileglobs (e.g. *.c) are not yet supported.

If a pattern "." is added, all changes in the git repository's working tree will be added.

File patterns are required unless isUpdate() == true or setAll(boolean) is called. If so and no file patterns are given, all changes will be added (i.e., a file pattern of "." is implied).

Parameters

filepattern:String: repository-relative path of file/directory to add (with / as separator)

Returns:AddCommand

this

call back to summary

call	back to summary
public DirCache call() throws GitAPIException, NoFilepatternException Implements abstract org.eclipse.jgit.api.GitCommand.call. Implements java.util.concurrent.Callable.call. Doc from org.eclipse.jgit.api.GitCommand.call. Computes a result, or throws an exception if unable to do so. Execute the command Executes the `Add` command. 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:DirCache Doc from java.util.concurrent.Callable.call. computed result Annotations @Override Exceptions NoFilepatternException: if no file patterns are given if `isUpdate() == false` and `setAll(boolean)` was not called JGitInternalException: on errors, but also if `isUpdate() == true` _and_ `setAll(boolean)` had been called

public DirCache call() throws GitAPIException, NoFilepatternException

Implements abstract org.eclipse.jgit.api.GitCommand.call.

Implements java.util.concurrent.Callable.call.

Doc from org.eclipse.jgit.api.GitCommand.call.

Computes a result, or throws an exception if unable to do so.

Execute the command

Executes the Add command. 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:DirCache

Doc from java.util.concurrent.Callable.call.

computed result

Annotations

@Override

Exceptions

NoFilepatternException:: if no file patterns are given if isUpdate() == false and setAll(boolean) was not called
JGitInternalException:: on errors, but also if isUpdate() == true _and_ setAll(boolean) had been called

isAll back to summary

isAll	back to summary
public boolean isAll() Tells whether '--all' has been set for this command. Returns:boolean `true` if it was set; `false` otherwise Since 7.2

public boolean isAll()

Tells whether '--all' has been set for this command.

Returns:boolean: true if it was set; false otherwise
Since: 7.2

isRenormalize back to summary

isRenormalize	back to summary
public boolean isRenormalize() Tells whether the command will renormalize by re-applying the "clean" process to tracked files. For legacy reasons, this is `true` by default. This setting is independent of `isUpdate()`. In C git, command-line option --renormalize implies --update. Returns:boolean whether files will be renormalized Since 6.6

public boolean isRenormalize()

Tells whether the command will renormalize by re-applying the "clean" process to tracked files.

For legacy reasons, this is true by default.

This setting is independent of isUpdate(). In C git, command-line option --renormalize implies --update.

Returns:boolean: whether files will be renormalized
Since: 6.6

isUpdate	back to summary
public boolean isUpdate() Whether to only match against already tracked files Returns:boolean whether to only match against already tracked files

isUpdate

back to summary

public boolean isUpdate()

Whether to only match against already tracked files

Returns:boolean: whether to only match against already tracked files

setAll back to summary

setAll	back to summary
public AddCommand setAll(boolean all) Defines whether the command will use '--all' mode: update existing index entries, add new entries, and remove index entries for which there is no file. (In other words: also stage deletions.) The setting is independent of `setUpdate(boolean)`. Parameters all:boolean whether to enable '--all' mode Returns:AddCommand `this` Since 7.2

public AddCommand setAll(boolean all)

Defines whether the command will use '--all' mode: update existing index entries, add new entries, and remove index entries for which there is no file. (In other words: also stage deletions.)

The setting is independent of setUpdate(boolean).

Parameters

all:boolean: whether to enable '--all' mode

Returns:AddCommand

this

Since

7.2

setRenormalize back to summary

setRenormalize	back to summary
public AddCommand setRenormalize(boolean renormalize) Defines whether the command will renormalize by re-applying the "clean" process to tracked files. This does not automatically call `setUpdate(boolean)`. Parameters renormalize:boolean whether to renormalize tracked files Returns:AddCommand `this` Since 6.6

public AddCommand setRenormalize(boolean renormalize)

Defines whether the command will renormalize by re-applying the "clean" process to tracked files.

This does not automatically call setUpdate(boolean).

Parameters

renormalize:boolean: whether to renormalize tracked files

Returns:AddCommand

this

Since

6.6

setUpdate back to summary

setUpdate	back to summary
public AddCommand setUpdate(boolean update) Set whether to only match against already tracked files. If `update == true`, re-sets a previous `setAll(boolean)`. Parameters update:boolean If set to true, the command only matches `filepattern` against already tracked files in the index rather than the working tree. That means that it will never stage new files, but that it will stage modified new contents of tracked files and that it will remove files from the index if the corresponding files in the working tree have been removed. In contrast to the git command line a `filepattern` must exist also if update is set to true as there is no concept of a working directory here. Returns:AddCommand `this`

public AddCommand setUpdate(boolean update)

Set whether to only match against already tracked files. If update == true, re-sets a previous setAll(boolean).

Parameters

update:boolean: If set to true, the command only matches filepattern against already tracked files in the index rather than the working tree. That means that it will never stage new files, but that it will stage modified new contents of tracked files and that it will remove files from the index if the corresponding files in the working tree have been removed. In contrast to the git command line a filepattern must exist also if update is set to true as there is no concept of a working directory here.

Returns:AddCommand

this

setWorkingTreeIterator back to summary

setWorkingTreeIterator	back to summary
public AddCommand setWorkingTreeIterator(WorkingTreeIterator f) Allow clients to provide their own implementation of a FileTreeIterator Parameters f:WorkingTreeIterator a `org.eclipse.jgit.treewalk.WorkingTreeIterator` object. Returns:AddCommand `this`

public AddCommand setWorkingTreeIterator(WorkingTreeIterator f)

Allow clients to provide their own implementation of a FileTreeIterator

Parameters

f:WorkingTreeIterator: a org.eclipse.jgit.treewalk.WorkingTreeIterator object.

Returns:AddCommand

this

public Class AddCommand

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail