Modifier and Type	Class and Description
public static enum	ReceiveCommand.Result Result of the update command.
public static enum	ReceiveCommand.Type Type of operation requested.

Modifier and Type	Field and Description
private boolean	customRefLog
private Boolean	forceRefLog
private String	message
private final String	name
private final ObjectId	newId
private final String	newSymref
private final ObjectId	oldId
private final String	oldSymref
private Ref	ref
private boolean	refLogIncludeResult
private String	refLogMessage
private ReceiveCommand.Result	status
private ReceiveCommand.Type	type
private boolean	typeIsCorrect

Constructor Summary

Access	Constructor and Description
public	ReceiveCommand(final ObjectId the expected old object id; must not be null. Use `org.eclipse.jgit.lib.ObjectId#zeroId()` to indicate a ref creation. oldId, final ObjectId the new object id; must not be null. Use `org.eclipse.jgit.lib.ObjectId#zeroId()` to indicate a ref deletion. newId, final String name of the ref being affected. name) Create a new command for `org.eclipse.jgit.transport.ReceivePack`.
public	ReceiveCommand(final ObjectId the old object id; must not be null. Use `org.eclipse.jgit.lib.ObjectId#zeroId()` to indicate a ref creation. oldId, final ObjectId the new object id; must not be null. Use `org.eclipse.jgit.lib.ObjectId#zeroId()` to indicate a ref deletion. newId, final String name of the ref being affected. name, final ReceiveCommand.Type type of the command. Must be `org.eclipse.jgit.transport.ReceiveCommand.Type#CREATE` if `oldId` is zero, or `org.eclipse.jgit.transport.ReceiveCommand.Type#DELETE` if `newId` is zero. type) Create a new command for `org.eclipse.jgit.transport.ReceivePack`.
private	ReceiveCommand(ObjectId the old object id; must not be null. Use `ObjectId#zeroId()` to indicate a ref creation. oldId, String new target, must begin with `"refs/"`. Use `null` to indicate a ref deletion. newSymref, String name of the reference to make symbolic. name) Create a command to switch a reference from object to symbolic.
private	ReceiveCommand(String expected old target. Use `null` to indicate a ref creation. oldSymref, ObjectId the new object id; must not be null. Use `ObjectId#zeroId()` to indicate a ref deletion. newId, String name of the reference to convert from symbolic. name) Create a command to switch a reference from symbolic to object.
private	ReceiveCommand(String expected old target. Use `null` to indicate a ref creation. oldTarget, String new target. Use `null` to indicate a ref deletion. newTarget, String name of the reference to make symbolic. name) Create a command to switch a symbolic reference's target.

Method Summary

Modifier and Type	Method and Description
public static void	abort(Iterable<ReceiveCommand> commands to mark as failed. commands) Set unprocessed commands as failed due to transaction aborted.
public void	disableRefLog() Don't record this update in the ref's associated reflog.
public void	execute(ReceivePack receive-pack session. rp) Execute this command during a receive-pack session.
public static List<ReceiveCommand>	Returns: a copy of the command list containing only those commands with the desired status. filter(Iterable<ReceiveCommand> commands to filter. in, ReceiveCommand.Result desired status to filter by. want) Filter a collection of commands according to result.
public static List<ReceiveCommand>	Returns: a copy of the command list containing only those commands with the desired status. filter(List<ReceiveCommand> commands to filter. commands, ReceiveCommand.Result desired status to filter by. want) Filter a list of commands according to result.
public String	Returns: the message associated with a failure status. getMessage() Get the message associated with a failure status.
public ObjectId	Returns: the requested new value for this ref. getNewId() Get the requested new value for this ref.
public String	Returns: requested new target for a symbolic reference. getNewSymref() Get requested new target for a symbolic reference.
public ObjectId	Returns: the old value the client thinks the ref has. getOldId() Get the old value the client thinks the ref has.
public String	Returns: expected old target for a symbolic reference. getOldSymref() Get expected old target for a symbolic reference.
public Ref	Returns: the ref, if this was advertised by the connection. getRef() Get the ref, if this was advertised by the connection.
public String	Returns: message the caller wants to include in the reflog; null if the update should not be logged. getRefLogMessage() Get the message to include in the reflog.
public String	Returns: the name of the ref being updated. getRefName() Get the name of the ref being updated.
public ReceiveCommand.Result	Returns: the current status code of this command. getResult() Get the current status code of this command.
public ReceiveCommand.Type	Returns: the type of this command; see `Type`. getType() Get the type of this command; see `Type`.
public boolean	Returns: whether a custom reflog is set. hasCustomRefLog() Check whether this command has a custom reflog message setting that should override defaults in any containing `org.eclipse.jgit.lib.BatchRefUpdate`.
public Boolean	Returns: whether force writing is enabled; `null` if `#setForceRefLog(boolean)` was never called. isForceRefLog() Check whether the reflog should be written regardless of repo defaults.
public boolean	Returns: true if disabled. isRefLogDisabled() Check whether log has been disabled by `disableRefLog()`.
public boolean	Returns: true if the message should include the result. isRefLogIncludingResult() Check whether the reflog message should include the result of the update, such as fast-forward or force-update.
public static boolean	Returns: whether the command failed due to transaction aborted, as in `abort(Iterable)`. isTransactionAborted(ReceiveCommand command. cmd) Check whether a command failed due to transaction aborted.
public static ReceiveCommand	Returns: command instance. link(ObjectId expected oldId. May be `zeroId` to create. oldId, String new target; must begin with `"refs/"`. newTarget, String name of the reference to make symbolic. name) Create a command to switch a reference from object to symbolic.
public static ReceiveCommand	Returns: command instance. link(String expected old target. May be null to create. oldTarget, String new target; must begin with `"refs/"`. newTarget, String name of the reference to make symbolic. name) Create a command to switch a symbolic reference's target.
pack-priv void	reject(IOException err)
public void	setForceRefLog(boolean whether to force. force) Force writing a reflog for the updated ref.
pack-priv void	setRef(Ref r)
public void	setRefLogMessage(String the message to describe this change. If null and appendStatus is false, the reflog will not be updated. msg, boolean true if the status of the ref change (fast-forward or forced-update) should be appended to the user supplied message. appendStatus) Set the message to include in the reflog.
public void	setResult(ReceiveCommand.Result the new status code for this command. s) Set the status of this command.
public void	setResult(ReceiveCommand.Result new status code for this command. s, String optional message explaining the new status. m) Set the status of this command.
public void	setResult(RefUpdate.Result the new result code for this command. r) Set the result of this command.
pack-priv void	setType(ReceiveCommand.Type t)
pack-priv void	setTypeFastForwardUpdate()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public static ReceiveCommand	Returns: command instance. unlink(String expected old target. oldTarget, ObjectId new object identifier. May be `zeroId()` to delete. newId, String name of the reference to convert from symbolic. name) Create a command to switch a reference from symbolic to object.
public void	updateType(RevWalk an instance to perform the merge test with. The caller must allocate and release this object. walk) Update the type of this command by checking for fast-forward.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

customRefLog	back to summary
private boolean customRefLog

forceRefLog	back to summary
private Boolean forceRefLog

message	back to summary
private String message

name	back to summary
private final String name

newId	back to summary
private final ObjectId newId

newSymref	back to summary
private final String newSymref

oldId	back to summary
private final ObjectId oldId

oldSymref	back to summary
private final String oldSymref

ref	back to summary
private Ref ref

refLogIncludeResult	back to summary
private boolean refLogIncludeResult

refLogMessage	back to summary
private String refLogMessage

status	back to summary
private ReceiveCommand.Result status

type	back to summary
private ReceiveCommand.Type type

typeIsCorrect	back to summary
private boolean typeIsCorrect

Constructor Detail

ReceiveCommand back to summary

ReceiveCommand	back to summary
public ReceiveCommand(final ObjectId oldId, final ObjectId newId, final String name) Create a new command for `org.eclipse.jgit.transport.ReceivePack`. Parameters oldId:ObjectId the expected old object id; must not be null. Use `org.eclipse.jgit.lib.ObjectId#zeroId()` to indicate a ref creation. newId:ObjectId the new object id; must not be null. Use `org.eclipse.jgit.lib.ObjectId#zeroId()` to indicate a ref deletion. name:String name of the ref being affected.

public ReceiveCommand(final ObjectId oldId, final ObjectId newId, final String name)

Create a new command for org.eclipse.jgit.transport.ReceivePack.

Parameters

oldId:ObjectId: the expected old object id; must not be null. Use org.eclipse.jgit.lib.ObjectId#zeroId() to indicate a ref creation.
newId:ObjectId: the new object id; must not be null. Use org.eclipse.jgit.lib.ObjectId#zeroId() to indicate a ref deletion.
name:String: name of the ref being affected.

ReceiveCommand back to summary

ReceiveCommand	back to summary
public ReceiveCommand(final ObjectId oldId, final ObjectId newId, final String name, final ReceiveCommand.Type type) Create a new command for `org.eclipse.jgit.transport.ReceivePack`. Parameters oldId:ObjectId the old object id; must not be null. Use `org.eclipse.jgit.lib.ObjectId#zeroId()` to indicate a ref creation. newId:ObjectId the new object id; must not be null. Use `org.eclipse.jgit.lib.ObjectId#zeroId()` to indicate a ref deletion. name:String name of the ref being affected. type:ReceiveCommand.Type type of the command. Must be `org.eclipse.jgit.transport.ReceiveCommand.Type#CREATE` if `oldId` is zero, or `org.eclipse.jgit.transport.ReceiveCommand.Type#DELETE` if `newId` is zero. Since 2.0

public ReceiveCommand(final ObjectId oldId, final ObjectId newId, final String name, final ReceiveCommand.Type type)

Create a new command for org.eclipse.jgit.transport.ReceivePack.

Parameters

oldId:ObjectId: the old object id; must not be null. Use org.eclipse.jgit.lib.ObjectId#zeroId() to indicate a ref creation.
newId:ObjectId: the new object id; must not be null. Use org.eclipse.jgit.lib.ObjectId#zeroId() to indicate a ref deletion.
name:String: name of the ref being affected.
type:ReceiveCommand.Type: type of the command. Must be org.eclipse.jgit.transport.ReceiveCommand.Type#CREATE if oldId is zero, or org.eclipse.jgit.transport.ReceiveCommand.Type#DELETE if newId is zero.

Since

2.0

ReceiveCommand back to summary

ReceiveCommand	back to summary
private ReceiveCommand(ObjectId oldId, String newSymref, String name) Create a command to switch a reference from object to symbolic. Parameters oldId:ObjectId the old object id; must not be null. Use `ObjectId#zeroId()` to indicate a ref creation. newSymref:String new target, must begin with `"refs/"`. Use `null` to indicate a ref deletion. name:String name of the reference to make symbolic. Since 4.10

private ReceiveCommand(ObjectId oldId, String newSymref, String name)

Create a command to switch a reference from object to symbolic.

Parameters

oldId:ObjectId: the old object id; must not be null. Use ObjectId#zeroId() to indicate a ref creation.
newSymref:String: new target, must begin with "refs/". Use null to indicate a ref deletion.
name:String: name of the reference to make symbolic.

Since

4.10

ReceiveCommand back to summary

ReceiveCommand	back to summary
private ReceiveCommand(String oldSymref, ObjectId newId, String name) Create a command to switch a reference from symbolic to object. Parameters oldSymref:String expected old target. Use `null` to indicate a ref creation. newId:ObjectId the new object id; must not be null. Use `ObjectId#zeroId()` to indicate a ref deletion. name:String name of the reference to convert from symbolic. Since 4.10

private ReceiveCommand(String oldSymref, ObjectId newId, String name)

Create a command to switch a reference from symbolic to object.

Parameters

oldSymref:String: expected old target. Use null to indicate a ref creation.
newId:ObjectId: the new object id; must not be null. Use ObjectId#zeroId() to indicate a ref deletion.
name:String: name of the reference to convert from symbolic.

Since

4.10

ReceiveCommand back to summary

ReceiveCommand	back to summary
private ReceiveCommand(String oldTarget, String newTarget, String name) Create a command to switch a symbolic reference's target. Parameters oldTarget:String expected old target. Use `null` to indicate a ref creation. newTarget:String new target. Use `null` to indicate a ref deletion. name:String name of the reference to make symbolic. Since 4.10

private ReceiveCommand(String oldTarget, String newTarget, String name)

Create a command to switch a symbolic reference's target.

Parameters

oldTarget:String: expected old target. Use null to indicate a ref creation.
newTarget:String: new target. Use null to indicate a ref deletion.
name:String: name of the reference to make symbolic.

Since

4.10

Method Detail

abort back to summary

abort	back to summary
public static void abort(Iterable<ReceiveCommand> commands) Set unprocessed commands as failed due to transaction aborted. If a command is still `org.eclipse.jgit.transport.ReceiveCommand.Result#NOT_ATTEMPTED` it will be set to `org.eclipse.jgit.transport.ReceiveCommand.Result#REJECTED_OTHER_REASON`. Parameters commands:Iterable<ReceiveCommand> commands to mark as failed. Since 4.2

public static void abort(Iterable<ReceiveCommand> commands)

Set unprocessed commands as failed due to transaction aborted.

If a command is still org.eclipse.jgit.transport.ReceiveCommand.Result#NOT_ATTEMPTED it will be set to org.eclipse.jgit.transport.ReceiveCommand.Result#REJECTED_OTHER_REASON.

Parameters

commands:Iterable<ReceiveCommand>: commands to mark as failed.

Since

4.2

disableRefLog back to summary

disableRefLog	back to summary
public void disableRefLog() Don't record this update in the ref's associated reflog. Equivalent to `setRefLogMessage(null, false)`. Since 4.9

public void disableRefLog()

Don't record this update in the ref's associated reflog.

Equivalent to setRefLogMessage(null, false).

Since: 4.9

execute	back to summary
public void execute(ReceivePack rp) Execute this command during a receive-pack session. Sets the status of the command as a side effect. Parameters rp:ReceivePack receive-pack session. Since 5.6

execute

back to summary

public void execute(ReceivePack rp)

Execute this command during a receive-pack session.

Sets the status of the command as a side effect.

Parameters

rp:ReceivePack: receive-pack session.

Since

5.6

filter	back to summary
public static List<ReceiveCommand> filter(Iterable<ReceiveCommand> in, ReceiveCommand.Result want) Filter a collection of commands according to result. Parameters in:Iterable<ReceiveCommand> commands to filter. want:ReceiveCommand.Result desired status to filter by. Returns:List<ReceiveCommand> a copy of the command list containing only those commands with the desired status. Since 4.2

filter

back to summary

public static List<ReceiveCommand> filter(Iterable<ReceiveCommand> in, ReceiveCommand.Result want)

Filter a collection of commands according to result.

Parameters

in:Iterable<ReceiveCommand>: commands to filter.
want:ReceiveCommand.Result: desired status to filter by.

Returns:List<ReceiveCommand>

a copy of the command list containing only those commands with the desired status.

Since

4.2

filter	back to summary
public static List<ReceiveCommand> filter(List<ReceiveCommand> commands, ReceiveCommand.Result want) Filter a list of commands according to result. Parameters commands:List<ReceiveCommand> commands to filter. want:ReceiveCommand.Result desired status to filter by. Returns:List<ReceiveCommand> a copy of the command list containing only those commands with the desired status. Since 2.0

filter

back to summary

public static List<ReceiveCommand> filter(List<ReceiveCommand> commands, ReceiveCommand.Result want)

Filter a list of commands according to result.

Parameters

commands:List<ReceiveCommand>: commands to filter.
want:ReceiveCommand.Result: desired status to filter by.

Returns:List<ReceiveCommand>

a copy of the command list containing only those commands with the desired status.

Since

2.0

getMessage	back to summary
public String getMessage() Get the message associated with a failure status. Returns:String the message associated with a failure status.

getMessage

back to summary

public String getMessage()

Get the message associated with a failure status.

Returns:String: the message associated with a failure status.

getNewId	back to summary
public ObjectId getNewId() Get the requested new value for this ref. Returns:ObjectId the requested new value for this ref.

getNewId

back to summary

public ObjectId getNewId()

Get the requested new value for this ref.

Returns:ObjectId: the requested new value for this ref.

getNewSymref	back to summary
public String getNewSymref() Get requested new target for a symbolic reference. Returns:String requested new target for a symbolic reference. Annotations @Nullable Since 4.10

getNewSymref

back to summary

public String getNewSymref()

Get requested new target for a symbolic reference.

Returns:String

requested new target for a symbolic reference.

Annotations

@Nullable

Since

4.10

getOldId	back to summary
public ObjectId getOldId() Get the old value the client thinks the ref has. Returns:ObjectId the old value the client thinks the ref has.

getOldId

back to summary

public ObjectId getOldId()

Get the old value the client thinks the ref has.

Returns:ObjectId: the old value the client thinks the ref has.

getOldSymref	back to summary
public String getOldSymref() Get expected old target for a symbolic reference. Returns:String expected old target for a symbolic reference. Annotations @Nullable Since 4.10

getOldSymref

back to summary

public String getOldSymref()

Get expected old target for a symbolic reference.

Returns:String

expected old target for a symbolic reference.

Annotations

@Nullable

Since

4.10

getRef	back to summary
public Ref getRef() Get the ref, if this was advertised by the connection. Returns:Ref the ref, if this was advertised by the connection.

getRef

back to summary

public Ref getRef()

Get the ref, if this was advertised by the connection.

Returns:Ref: the ref, if this was advertised by the connection.

getRefLogMessage	back to summary
public String getRefLogMessage() Get the message to include in the reflog. Returns:String message the caller wants to include in the reflog; null if the update should not be logged. Annotations @Nullable Since 4.9

getRefLogMessage

back to summary

public String getRefLogMessage()

Get the message to include in the reflog.

Returns:String

message the caller wants to include in the reflog; null if the update should not be logged.

Annotations

@Nullable

Since

4.9

getRefName	back to summary
public String getRefName() Get the name of the ref being updated. Returns:String the name of the ref being updated.

getRefName

back to summary

public String getRefName()

Get the name of the ref being updated.

Returns:String: the name of the ref being updated.

getResult	back to summary
public ReceiveCommand.Result getResult() Get the current status code of this command. Returns:ReceiveCommand.Result the current status code of this command.

getResult

back to summary

public ReceiveCommand.Result getResult()

Get the current status code of this command.

Returns:ReceiveCommand.Result: the current status code of this command.

getType back to summary

getType	back to summary
public ReceiveCommand.Type getType() Get the type of this command; see `Type`. Returns:ReceiveCommand.Type the type of this command; see `Type`.

public ReceiveCommand.Type getType()

Get the type of this command; see Type.

Returns:ReceiveCommand.Type: the type of this command; see Type.

hasCustomRefLog back to summary

hasCustomRefLog	back to summary
public boolean hasCustomRefLog() Check whether this command has a custom reflog message setting that should override defaults in any containing `org.eclipse.jgit.lib.BatchRefUpdate`. Does not take into account whether `#setForceRefLog(boolean)` has been called. Returns:boolean whether a custom reflog is set. Since 4.9

public boolean hasCustomRefLog()

Check whether this command has a custom reflog message setting that should override defaults in any containing org.eclipse.jgit.lib.BatchRefUpdate.

Does not take into account whether #setForceRefLog(boolean) has been called.

Returns:boolean: whether a custom reflog is set.
Since: 4.9

isForceRefLog back to summary

isForceRefLog	back to summary
public Boolean isForceRefLog() Check whether the reflog should be written regardless of repo defaults. Returns:Boolean whether force writing is enabled; `null` if `#setForceRefLog(boolean)` was never called. Annotations @Nullable Since 4.9

public Boolean isForceRefLog()

Check whether the reflog should be written regardless of repo defaults.

Returns:Boolean

whether force writing is enabled; null if #setForceRefLog(boolean) was never called.

Annotations

@Nullable

Since

4.9

isRefLogDisabled back to summary

isRefLogDisabled	back to summary
public boolean isRefLogDisabled() Check whether log has been disabled by `disableRefLog()`. Returns:boolean true if disabled. Since 4.9

public boolean isRefLogDisabled()

Check whether log has been disabled by disableRefLog().

Returns:boolean: true if disabled.
Since: 4.9

isRefLogIncludingResult	back to summary
public boolean isRefLogIncludingResult() Check whether the reflog message should include the result of the update, such as fast-forward or force-update. Returns:boolean true if the message should include the result. Since 4.9

isRefLogIncludingResult

back to summary

public boolean isRefLogIncludingResult()

Check whether the reflog message should include the result of the update, such as fast-forward or force-update.

Returns:boolean: true if the message should include the result.
Since: 4.9

isTransactionAborted back to summary

isTransactionAborted	back to summary
public static boolean isTransactionAborted(ReceiveCommand cmd) Check whether a command failed due to transaction aborted. Parameters cmd:ReceiveCommand command. Returns:boolean whether the command failed due to transaction aborted, as in `abort(Iterable)`. Since 4.9

public static boolean isTransactionAborted(ReceiveCommand cmd)

Check whether a command failed due to transaction aborted.

Parameters

cmd:ReceiveCommand: command.

Returns:boolean

whether the command failed due to transaction aborted, as in abort(Iterable).

Since

4.9

link back to summary

link	back to summary
public static ReceiveCommand link(ObjectId oldId, String newTarget, String name) Create a command to switch a reference from object to symbolic. Parameters oldId:ObjectId expected oldId. May be `zeroId` to create. newTarget:String new target; must begin with `"refs/"`. name:String name of the reference to make symbolic. Returns:ReceiveCommand command instance. Since 4.10

public static ReceiveCommand link(ObjectId oldId, String newTarget, String name)

Create a command to switch a reference from object to symbolic.

Parameters

oldId:ObjectId: expected oldId. May be zeroId to create.
newTarget:String: new target; must begin with "refs/".
name:String: name of the reference to make symbolic.

Returns:ReceiveCommand

command instance.

Since

4.10

link back to summary

link	back to summary
public static ReceiveCommand link(String oldTarget, String newTarget, String name) Create a command to switch a symbolic reference's target. Parameters oldTarget:String expected old target. May be null to create. newTarget:String new target; must begin with `"refs/"`. name:String name of the reference to make symbolic. Returns:ReceiveCommand command instance. Since 4.10

public static ReceiveCommand link(String oldTarget, String newTarget, String name)

Create a command to switch a symbolic reference's target.

Parameters

oldTarget:String: expected old target. May be null to create.
newTarget:String: new target; must begin with "refs/".
name:String: name of the reference to make symbolic.

Returns:ReceiveCommand

command instance.

Since

4.10

reject	back to summary
pack-priv void reject(IOException err)

setForceRefLog	back to summary
public void setForceRefLog(boolean force) Force writing a reflog for the updated ref. Parameters force:boolean whether to force. Since 4.9

setForceRefLog

back to summary

public void setForceRefLog(boolean force)

Force writing a reflog for the updated ref.

Parameters

force:boolean: whether to force.

Since

4.9

setRef	back to summary
pack-priv void setRef(Ref r)

setRefLogMessage back to summary

setRefLogMessage	back to summary
public void setRefLogMessage(String msg, boolean appendStatus) Set the message to include in the reflog. Overrides the default set by `setRefLogMessage` on any containing `org.eclipse.jgit.lib.BatchRefUpdate`. Parameters msg:String the message to describe this change. If null and appendStatus is false, the reflog will not be updated. appendStatus:boolean true if the status of the ref change (fast-forward or forced-update) should be appended to the user supplied message. Since 4.9

public void setRefLogMessage(String msg, boolean appendStatus)

Set the message to include in the reflog.

Overrides the default set by setRefLogMessage on any containing org.eclipse.jgit.lib.BatchRefUpdate.

Parameters

msg:String: the message to describe this change. If null and appendStatus is false, the reflog will not be updated.
appendStatus:boolean: true if the status of the ref change (fast-forward or forced-update) should be appended to the user supplied message.

Since

4.9

setResult	back to summary
public void setResult(ReceiveCommand.Result s) Set the status of this command. Parameters s:ReceiveCommand.Result the new status code for this command.

setResult

back to summary

public void setResult(ReceiveCommand.Result s)

Set the status of this command.

Parameters

s:ReceiveCommand.Result: the new status code for this command.

setResult

back to summary

public void setResult(ReceiveCommand.Result s, String m)

Set the status of this command.

Parameters

s:ReceiveCommand.Result: new status code for this command.
m:String: optional message explaining the new status.

setResult

back to summary

public void setResult(RefUpdate.Result r)

Set the result of this command.

Parameters

r:RefUpdate.Result: the new result code for this command.

setType	back to summary
pack-priv void setType(ReceiveCommand.Type t)

setTypeFastForwardUpdate	back to summary
pack-priv void setTypeFastForwardUpdate()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@SuppressWarnings:nls
@Override

unlink back to summary

public static ReceiveCommand unlink(String oldTarget, ObjectId newId, String name)

Create a command to switch a reference from symbolic to object.

Parameters

oldTarget:String: expected old target.
newId:ObjectId: new object identifier. May be zeroId() to delete.
name:String: name of the reference to convert from symbolic.

Returns:ReceiveCommand

command instance.

Since

4.10

updateType back to summary

public void updateType(RevWalk walk) throws IOException

Update the type of this command by checking for fast-forward.

If the command's current type is UPDATE, a merge test will be performed using the supplied RevWalk to determine if getOldId() is fully merged into getNewId(). If some commits are not merged the update type is changed to org.eclipse.jgit.transport.ReceiveCommand.Type#UPDATE_NONFASTFORWARD.

Parameters

walk:RevWalk: an instance to perform the merge test with. The caller must allocate and release this object.

Exceptions

IOException:: either oldId or newId is not accessible in the repository used by the RevWalk. This usually indicates data corruption, and the command cannot be processed.

org.eclipse.jgit.transport back to summary

public final Enum ReceiveCommand.Result

Class Inheritance

extends Enum<ReceiveCommand.Result>

java.lang.Object
java.lang.Enum
org.eclipse.jgit.transport.ReceiveCommand.Result

Result of the update command.

Field Summary

Modifier and Type	Field and Description
public static final ReceiveCommand.Result	LOCK_FAILURE The ref could not be locked and updated atomically; try again.
public static final ReceiveCommand.Result	NOT_ATTEMPTED The command has not yet been attempted by the server.
public static final ReceiveCommand.Result	OK The change was completed successfully.
public static final ReceiveCommand.Result	REJECTED_CURRENT_BRANCH The update affects `HEAD` and cannot be permitted.
public static final ReceiveCommand.Result	REJECTED_MISSING_OBJECT One or more objects aren't in the repository.
public static final ReceiveCommand.Result	REJECTED_NOCREATE The server is configured to deny creation of this ref.
public static final ReceiveCommand.Result	REJECTED_NODELETE The server is configured to deny deletion of this ref.
public static final ReceiveCommand.Result	REJECTED_NONFASTFORWARD The update is a non-fast-forward update and isn't permitted.
public static final ReceiveCommand.Result	REJECTED_OTHER_REASON Other failure; see `ReceiveCommand#getMessage()`.

Constructor Summary

Access	Constructor and Description
private	Result()

Method Summary

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

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

Field Detail

LOCK_FAILURE	back to summary
public static final ReceiveCommand.Result LOCK_FAILURE The ref could not be locked and updated atomically; try again.

NOT_ATTEMPTED	back to summary
public static final ReceiveCommand.Result NOT_ATTEMPTED The command has not yet been attempted by the server.

OK	back to summary
public static final ReceiveCommand.Result OK The change was completed successfully.

REJECTED_CURRENT_BRANCH	back to summary
public static final ReceiveCommand.Result REJECTED_CURRENT_BRANCH The update affects `HEAD` and cannot be permitted.

REJECTED_MISSING_OBJECT

back to summary

public static final ReceiveCommand.Result REJECTED_MISSING_OBJECT

One or more objects aren't in the repository.

This is severe indication of either repository corruption on the server side, or a bug in the client wherein the client did not supply all required objects during the pack transfer.

REJECTED_NOCREATE	back to summary
public static final ReceiveCommand.Result REJECTED_NOCREATE The server is configured to deny creation of this ref.

REJECTED_NODELETE	back to summary
public static final ReceiveCommand.Result REJECTED_NODELETE The server is configured to deny deletion of this ref.

REJECTED_NONFASTFORWARD	back to summary
public static final ReceiveCommand.Result REJECTED_NONFASTFORWARD The update is a non-fast-forward update and isn't permitted.

REJECTED_OTHER_REASON	back to summary
public static final ReceiveCommand.Result REJECTED_OTHER_REASON Other failure; see `ReceiveCommand#getMessage()`.

Constructor Detail

Result	back to summary
private Result()

Method Detail

valueOf	back to summary
public static ReceiveCommand.Result valueOf(String name)

values	back to summary
public static ReceiveCommand.Result[] values()

Modifier and Type	Field and Description
public static final ReceiveCommand.Type	CREATE Create a new ref; the ref must not already exist.
public static final ReceiveCommand.Type	DELETE Delete an existing ref; the ref should already exist.
public static final ReceiveCommand.Type	UPDATE Update an existing ref with a fast-forward update.
public static final ReceiveCommand.Type	UPDATE_NONFASTFORWARD Update an existing ref by potentially discarding objects.

public Class ReceiveCommand

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ReceiveCommand.Result

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ReceiveCommand.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

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