Modifier and Type	Class and Description
public static enum	MergeCommand.ConflictStyle Values for the "merge.conflictStyle" git config.
public static enum	MergeCommand.FastForwardMode The modes available for fast forward merges corresponding to the `--ff`, `--no-ff` and `--ff-only` options under `branch.`

Modifier and Type	Field and Description
private Boolean	commit
private List<Ref>	commits
private ContentMergeStrategy	contentStrategy
private MergeCommand.FastForwardMode	fastForwardMode
private boolean	insertChangeId
private MergeStrategy	mergeStrategy
private String	message
private ProgressMonitor	monitor
private Boolean	squash

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

Method Summary

Modifier and Type	Method and Description
public MergeResult	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.
private void	checkParameters()
private void	fallBackToConfiguration() Use values from the configuration if they have not been explicitly defined via the setters
public MergeCommand	Returns: `this` include(Ref a reference to a commit which is merged with the current head aCommit) Reference to a commit to be merged with the current head
public MergeCommand	Returns: `this` include(AnyObjectId the Id of a commit which is merged with the current head aCommit) Id of a commit which is to be merged with the current head
public MergeCommand	Returns: `this` include(String a name of a `Ref` pointing to the commit name, AnyObjectId the Id of a commit which is merged with the current head aCommit) Include a commit
public MergeCommand	Returns: `this` setCommit(boolean `true` if this command should commit (this is the default behavior). `false` if this command should not commit. In case the merge was successful but this flag was set to `false` a `org.eclipse.jgit.api.MergeResult` with type `org.eclipse.jgit.api.MergeResult` with status `org.eclipse.jgit.api.MergeResult.MergeStatus#MERGED_NOT_COMMITTED` is returned commit) Controls whether the merge command should automatically commit after a successful merge
public MergeCommand	Returns: `this` setContentMergeStrategy(ContentMergeStrategy the `ContentMergeStrategy` to be used strategy) Sets the content merge strategy to use if the `merge strategy` is "resolve" or "recursive".
public MergeCommand	Returns: `this` setFastForward(MergeCommand.FastForwardMode corresponds to the --ff/--no-ff/--ff-only options. If `null` use the value of the `merge.ff` option configured in git config. If this option is not configured --ff is the built-in default. fastForwardMode) Sets the fast forward mode.
public MergeCommand	Returns: `this` setInsertChangeId(boolean whether to insert a change id insertChangeId) If set to true a change id will be inserted into the commit message An existing change id is not replaced.
public MergeCommand	Returns: `this` setMessage(String the message to be used for the merge commit message) Set the commit message to be used for the merge commit (in case one is created)
public MergeCommand	Returns: this instance setProgressMonitor(ProgressMonitor A progress monitor monitor) The progress monitor associated with the diff operation.
public MergeCommand	Returns: `this` setSquash(boolean whether to squash commits or not squash) If `true`, will prepare the next commit in working tree and index as if a real merge happened, but do not make the commit or move the HEAD.
public MergeCommand	Returns: `this` setStrategy(MergeStrategy the `org.eclipse.jgit.merge.MergeStrategy` to be used mergeStrategy) Set merge strategy
private void	updateHead(StringBuilder refLogMessage, ObjectId newHeadId, ObjectId oldHeadID)

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

commit	back to summary
private Boolean commit

commits	back to summary
private List<Ref> commits

contentStrategy	back to summary
private ContentMergeStrategy contentStrategy

fastForwardMode	back to summary
private MergeCommand.FastForwardMode fastForwardMode

insertChangeId	back to summary
private boolean insertChangeId

mergeStrategy	back to summary
private MergeStrategy mergeStrategy

message	back to summary
private String message

monitor	back to summary
private ProgressMonitor monitor

squash	back to summary
private Boolean squash

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

Method Detail

call back to summary

call	back to summary
public MergeResult call() throws GitAPIException, NoHeadException, ConcurrentRefUpdateException, CheckoutConflictException, InvalidMergeHeadsException, WrongRepositoryStateException, NoMessageException 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 Execute the `Merge` command with all the options and parameters collected by the setter methods (e.g. `include(Ref)`) 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:MergeResult Doc from java.util.concurrent.Callable.call. computed result Annotations @Override @SuppressWarnings:boxing

public MergeResult call() throws GitAPIException, NoHeadException, ConcurrentRefUpdateException, CheckoutConflictException, InvalidMergeHeadsException, WrongRepositoryStateException, NoMessageException

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

Execute the Merge command with all the options and parameters collected by the setter methods (e.g. include(Ref)) 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:MergeResult

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

computed result

Annotations

@Override
@SuppressWarnings:boxing

checkParameters	back to summary
private void checkParameters() throws InvalidMergeHeadsException

fallBackToConfiguration	back to summary
private void fallBackToConfiguration() Use values from the configuration if they have not been explicitly defined via the setters

include back to summary

include	back to summary
public MergeCommand include(Ref aCommit) Reference to a commit to be merged with the current head Parameters aCommit:Ref a reference to a commit which is merged with the current head Returns:MergeCommand `this`

public MergeCommand include(Ref aCommit)

Reference to a commit to be merged with the current head

Parameters

aCommit:Ref: a reference to a commit which is merged with the current head

Returns:MergeCommand

this

include back to summary

include	back to summary
public MergeCommand include(AnyObjectId aCommit) Id of a commit which is to be merged with the current head Parameters aCommit:AnyObjectId the Id of a commit which is merged with the current head Returns:MergeCommand `this`

public MergeCommand include(AnyObjectId aCommit)

Id of a commit which is to be merged with the current head

Parameters

aCommit:AnyObjectId: the Id of a commit which is merged with the current head

Returns:MergeCommand

this

include back to summary

include	back to summary
public MergeCommand include(String name, AnyObjectId aCommit) Include a commit Parameters name:String a name of a `Ref` pointing to the commit aCommit:AnyObjectId the Id of a commit which is merged with the current head Returns:MergeCommand `this`

public MergeCommand include(String name, AnyObjectId aCommit)

Include a commit

Parameters

name:String: a name of a Ref pointing to the commit
aCommit:AnyObjectId: the Id of a commit which is merged with the current head

Returns:MergeCommand

this

setCommit back to summary

setCommit	back to summary
public MergeCommand setCommit(boolean commit) Controls whether the merge command should automatically commit after a successful merge Parameters commit:boolean `true` if this command should commit (this is the default behavior). `false` if this command should not commit. In case the merge was successful but this flag was set to `false` a `org.eclipse.jgit.api.MergeResult` with type `org.eclipse.jgit.api.MergeResult` with status `org.eclipse.jgit.api.MergeResult.MergeStatus#MERGED_NOT_COMMITTED` is returned Returns:MergeCommand `this` Since 3.0

public MergeCommand setCommit(boolean commit)

Controls whether the merge command should automatically commit after a successful merge

Parameters

commit:boolean: true if this command should commit (this is the default behavior). false if this command should not commit. In case the merge was successful but this flag was set to false a org.eclipse.jgit.api.MergeResult with type org.eclipse.jgit.api.MergeResult with status org.eclipse.jgit.api.MergeResult.MergeStatus#MERGED_NOT_COMMITTED is returned

Returns:MergeCommand

this

Since

3.0

setContentMergeStrategy back to summary

setContentMergeStrategy	back to summary
public MergeCommand setContentMergeStrategy(ContentMergeStrategy strategy) Sets the content merge strategy to use if the `merge strategy` is "resolve" or "recursive". Parameters strategy:ContentMergeStrategy the `ContentMergeStrategy` to be used Returns:MergeCommand `this` Since 5.12

public MergeCommand setContentMergeStrategy(ContentMergeStrategy strategy)

Sets the content merge strategy to use if the merge strategy is "resolve" or "recursive".

Parameters

strategy:ContentMergeStrategy: the ContentMergeStrategy to be used

Returns:MergeCommand

this

Since

5.12

setFastForward back to summary

setFastForward	back to summary
public MergeCommand setFastForward(MergeCommand.FastForwardMode fastForwardMode) Sets the fast forward mode. Parameters fastForwardMode:MergeCommand.FastForwardMode corresponds to the --ff/--no-ff/--ff-only options. If `null` use the value of the `merge.ff` option configured in git config. If this option is not configured --ff is the built-in default. Returns:MergeCommand `this` Since 2.2

public MergeCommand setFastForward(MergeCommand.FastForwardMode fastForwardMode)

Sets the fast forward mode.

Parameters

fastForwardMode:MergeCommand.FastForwardMode: corresponds to the --ff/--no-ff/--ff-only options. If null use the value of the merge.ff option configured in git config. If this option is not configured --ff is the built-in default.

Returns:MergeCommand

this

Since

2.2

setInsertChangeId back to summary

setInsertChangeId	back to summary
public MergeCommand setInsertChangeId(boolean insertChangeId) If set to true a change id will be inserted into the commit message An existing change id is not replaced. An initial change id (I000...) will be replaced by the change id. Parameters insertChangeId:boolean whether to insert a change id Returns:MergeCommand `this` Since 5.0

public MergeCommand setInsertChangeId(boolean insertChangeId)

If set to true a change id will be inserted into the commit message An existing change id is not replaced. An initial change id (I000...) will be replaced by the change id.

Parameters

insertChangeId:boolean: whether to insert a change id

Returns:MergeCommand

this

Since

5.0

setMessage back to summary

setMessage	back to summary
public MergeCommand setMessage(String message) Set the commit message to be used for the merge commit (in case one is created) Parameters message:String the message to be used for the merge commit Returns:MergeCommand `this` Since 3.5

public MergeCommand setMessage(String message)

Set the commit message to be used for the merge commit (in case one is created)

Parameters

message:String: the message to be used for the merge commit

Returns:MergeCommand

this

Since

3.5

setProgressMonitor back to summary

setProgressMonitor	back to summary
public MergeCommand setProgressMonitor(ProgressMonitor monitor) The progress monitor associated with the diff operation. By default, this is set to `NullProgressMonitor` Parameters monitor:ProgressMonitor A progress monitor Returns:MergeCommand this instance Since 4.2 See Also `NullProgressMonitor`

public MergeCommand setProgressMonitor(ProgressMonitor monitor)

The progress monitor associated with the diff operation. By default, this is set to NullProgressMonitor

Parameters

monitor:ProgressMonitor: A progress monitor

Returns:MergeCommand

this instance

Since

4.2

See Also

NullProgressMonitor

setSquash back to summary

setSquash	back to summary
public MergeCommand setSquash(boolean squash) If `true`, will prepare the next commit in working tree and index as if a real merge happened, but do not make the commit or move the HEAD. Otherwise, perform the merge and commit the result. In case the merge was successful but this flag was set to `true` a `org.eclipse.jgit.api.MergeResult` with status `org.eclipse.jgit.api.MergeResult.MergeStatus#MERGED_SQUASHED` or `org.eclipse.jgit.api.MergeResult.MergeStatus#FAST_FORWARD_SQUASHED` is returned. Parameters squash:boolean whether to squash commits or not Returns:MergeCommand `this` Since 2.0

public MergeCommand setSquash(boolean squash)

If true, will prepare the next commit in working tree and index as if a real merge happened, but do not make the commit or move the HEAD. Otherwise, perform the merge and commit the result.

In case the merge was successful but this flag was set to true a org.eclipse.jgit.api.MergeResult with status org.eclipse.jgit.api.MergeResult.MergeStatus#MERGED_SQUASHED or org.eclipse.jgit.api.MergeResult.MergeStatus#FAST_FORWARD_SQUASHED is returned.

Parameters

squash:boolean: whether to squash commits or not

Returns:MergeCommand

this

Since

2.0

setStrategy back to summary

setStrategy	back to summary
public MergeCommand setStrategy(MergeStrategy mergeStrategy) Set merge strategy Parameters mergeStrategy:MergeStrategy the `org.eclipse.jgit.merge.MergeStrategy` to be used Returns:MergeCommand `this`

public MergeCommand setStrategy(MergeStrategy mergeStrategy)

Set merge strategy

Parameters

mergeStrategy:MergeStrategy: the org.eclipse.jgit.merge.MergeStrategy to be used

Returns:MergeCommand

this

updateHead	back to summary
private void updateHead(StringBuilder refLogMessage, ObjectId newHeadId, ObjectId oldHeadID) throws IOException, ConcurrentRefUpdateException

org.eclipse.jgit.api back to summary

public final Enum MergeCommand.ConflictStyle

Class Inheritance

extends Enum<MergeCommand.ConflictStyle>

java.lang.Object
java.lang.Enum
org.eclipse.jgit.api.MergeCommand.ConflictStyle

Values for the "merge.conflictStyle" git config.

Since: 5.12

Field Summary

Modifier and Type	Field and Description
public static final MergeCommand.ConflictStyle	DIFF3 "diff3" style: ours/base/theirs.
public static final MergeCommand.ConflictStyle	MERGE "merge" style: only ours/theirs.

Constructor Summary

Access	Constructor and Description
private	ConflictStyle()

Method Summary

Modifier and Type	Method and Description
public static MergeCommand.ConflictStyle	valueOf(String name)
public static MergeCommand.ConflictStyle[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DIFF3	back to summary
public static final MergeCommand.ConflictStyle DIFF3 "diff3" style: ours/base/theirs.

MERGE	back to summary
public static final MergeCommand.ConflictStyle MERGE "merge" style: only ours/theirs. This is the default.

Constructor Detail

ConflictStyle	back to summary
private ConflictStyle()

Method Detail

valueOf	back to summary
public static MergeCommand.ConflictStyle valueOf(String name)

values	back to summary
public static MergeCommand.ConflictStyle[] values()

org.eclipse.jgit.api back to summary

public final Enum MergeCommand.FastForwardMode

Class Inheritance

extends Enum<MergeCommand.FastForwardMode>
implements ConfigEnum

java.lang.Object
java.lang.Enum
org.eclipse.jgit.api.MergeCommand.FastForwardMode

All Implemented Interfaces

org.eclipse.jgit.lib.Config.ConfigEnum

The modes available for fast forward merges corresponding to the --ff, --no-ff and --ff-only options under branch.<name>.mergeoptions.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	MergeCommand.FastForwardMode.Merge The modes available for fast forward merges corresponding to the options under `merge.ff`.

Field Summary

Modifier and Type	Field and Description
public static final MergeCommand.FastForwardMode	FF Corresponds to the default --ff option (for a fast forward update the branch pointer only).
public static final MergeCommand.FastForwardMode	FF_ONLY Corresponds to the --ff-only option (abort unless the merge is a fast forward).
public static final MergeCommand.FastForwardMode	NO_FF Corresponds to the --no-ff option (create a merge commit even for a fast forward).

Constructor Summary

Access	Constructor and Description
private	FastForwardMode()

Method Summary

Modifier and Type	Method and Description
public boolean	matchConfigValue(String the string to match in) Implements org.eclipse.jgit.lib.Config.ConfigEnum.matchConfigValue. Checks if the given string matches with enum value.
public String	toConfigValue() Implements org.eclipse.jgit.lib.Config.ConfigEnum.toConfigValue. Converts enumeration value into a string to be save in config.
public static MergeCommand.FastForwardMode	valueOf(String name)
public static MergeCommand.FastForwardMode	Returns: the mapped `FastForwardMode` value valueOf(MergeCommand.FastForwardMode.Merge the `FastForwardMode.Merge` value to be mapped ffMode) Map from `FastForwardMode.Merge` to `FastForwardMode`.
public static MergeCommand.FastForwardMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

FF	back to summary
public static final MergeCommand.FastForwardMode FF Corresponds to the default --ff option (for a fast forward update the branch pointer only).

FF_ONLY	back to summary
public static final MergeCommand.FastForwardMode FF_ONLY Corresponds to the --ff-only option (abort unless the merge is a fast forward).

NO_FF	back to summary
public static final MergeCommand.FastForwardMode NO_FF Corresponds to the --no-ff option (create a merge commit even for a fast forward).

Constructor Detail

FastForwardMode	back to summary
private FastForwardMode()

Method Detail

matchConfigValue	back to summary
public boolean matchConfigValue(String in) Implements org.eclipse.jgit.lib.Config.ConfigEnum.matchConfigValue. Doc from org.eclipse.jgit.lib.Config.ConfigEnum.matchConfigValue. Checks if the given string matches with enum value. Parameters in:String the string to match Returns:boolean true if the given string matches enum value, false otherwise Annotations @Override

matchConfigValue

back to summary

public boolean matchConfigValue(String in)

Implements org.eclipse.jgit.lib.Config.ConfigEnum.matchConfigValue.

Doc from org.eclipse.jgit.lib.Config.ConfigEnum.matchConfigValue.

Checks if the given string matches with enum value.

Parameters

in:String: the string to match

Returns:boolean

true if the given string matches enum value, false otherwise

Annotations

@Override

toConfigValue	back to summary
public String toConfigValue() Implements org.eclipse.jgit.lib.Config.ConfigEnum.toConfigValue. Doc from org.eclipse.jgit.lib.Config.ConfigEnum.toConfigValue. Converts enumeration value into a string to be save in config. Returns:String the enum value as config string Annotations @Override

toConfigValue

back to summary

public String toConfigValue()

Implements org.eclipse.jgit.lib.Config.ConfigEnum.toConfigValue.

Doc from org.eclipse.jgit.lib.Config.ConfigEnum.toConfigValue.

Converts enumeration value into a string to be save in config.

Returns:String

the enum value as config string

Annotations

@Override

valueOf	back to summary
public static MergeCommand.FastForwardMode valueOf(String name)

valueOf back to summary

valueOf	back to summary
public static MergeCommand.FastForwardMode valueOf(MergeCommand.FastForwardMode.Merge ffMode) Map from `FastForwardMode.Merge` to `FastForwardMode`. Parameters ffMode:MergeCommand.FastForwardMode.Merge the `FastForwardMode.Merge` value to be mapped Returns:MergeCommand.FastForwardMode the mapped `FastForwardMode` value

public static MergeCommand.FastForwardMode valueOf(MergeCommand.FastForwardMode.Merge ffMode)

Map from FastForwardMode.Merge to FastForwardMode.

Parameters

ffMode:MergeCommand.FastForwardMode.Merge: the FastForwardMode.Merge value to be mapped

Returns:MergeCommand.FastForwardMode

the mapped FastForwardMode value

values	back to summary
public static MergeCommand.FastForwardMode[] values()

org.eclipse.jgit.api back to summary

public final Enum MergeCommand.FastForwardMode.Merge

Class Inheritance

extends Enum<MergeCommand.FastForwardMode.Merge>

java.lang.Object
java.lang.Enum
org.eclipse.jgit.api.MergeCommand.FastForwardMode.Merge

The modes available for fast forward merges corresponding to the options under merge.ff.

Field Summary

Modifier and Type	Field and Description
public static final MergeCommand.FastForwardMode.Merge	FALSE `FastForwardMode#NO_FF`.
public static final MergeCommand.FastForwardMode.Merge	ONLY `FastForwardMode#FF_ONLY`.
public static final MergeCommand.FastForwardMode.Merge	TRUE `FastForwardMode#FF`.

Constructor Summary

Access	Constructor and Description
private	Merge()

Method Summary

Modifier and Type	Method and Description
public static MergeCommand.FastForwardMode.Merge	valueOf(String name)
public static MergeCommand.FastForwardMode.Merge	Returns: the mapped `FastForwardMode.Merge` value valueOf(MergeCommand.FastForwardMode the `FastForwardMode` value to be mapped ffMode) Map from `FastForwardMode` to `FastForwardMode.Merge`.
public static MergeCommand.FastForwardMode.Merge[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

FALSE	back to summary
public static final MergeCommand.FastForwardMode.Merge FALSE `FastForwardMode#NO_FF`.

ONLY	back to summary
public static final MergeCommand.FastForwardMode.Merge ONLY `FastForwardMode#FF_ONLY`.

TRUE	back to summary
public static final MergeCommand.FastForwardMode.Merge TRUE `FastForwardMode#FF`.

Constructor Detail

Merge	back to summary
private Merge()

Method Detail

valueOf	back to summary
public static MergeCommand.FastForwardMode.Merge valueOf(String name)

valueOf back to summary

public static MergeCommand.FastForwardMode.Merge valueOf(MergeCommand.FastForwardMode ffMode)

Map from FastForwardMode to FastForwardMode.Merge.

Parameters

ffMode:MergeCommand.FastForwardMode: the FastForwardMode value to be mapped

Returns:MergeCommand.FastForwardMode.Merge

the mapped FastForwardMode.Merge value

values	back to summary
public static MergeCommand.FastForwardMode.Merge[] values()

public Class MergeCommand

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum MergeCommand.ConflictStyle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum MergeCommand.FastForwardMode

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum MergeCommand.FastForwardMode.Merge

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail