Modifier and Type	Class and Description
public static enum	RefUpdate.Result Status of an update request.
private abstract static class	RefUpdate.Store Handle the abstraction of storing a ref update.

Modifier and Type	Field and Description
private boolean	checkConflicting
private boolean	detachingSymbolicRef Is this RefUpdate detaching a symbolic ref?
private ObjectId	expValue If non-null, the value `oldValue` must have to continue.
private boolean	force Does this specification ask for forced updated (rewind/reset)?
private boolean	forceRefLog Should reflogs be written even if the configured default for this ref is not to write it.
private ObjectId	newValue New value the caller wants this ref to have.
private ObjectId	oldValue Old value of the ref, obtained after we lock it.
private PushCertificate	pushCert Push certificate associated with this update.
private final Ref	ref
private PersonIdent	refLogIdent Identity to record action as within the reflog.
private boolean	refLogIncludeResult Should the Result value be appended to `refLogMessage`.
private String	refLogMessage Message the caller wants included in the reflog.
private RefUpdate.Result	result Result of the update operation.

Access	Constructor and Description
protected	RefUpdate(Ref the reference that will be updated by this operation. ref) Construct a new update operation for the reference.

Method Summary

Modifier and Type	Method and Description
public RefUpdate.Result	Returns: the result status of the delete. delete() Delete the ref.
public RefUpdate.Result	Returns: the result status of the delete. delete(RevWalk a RevWalk instance this delete command can borrow to perform the merge test. The walk will be reset to perform the test. walk) Delete the ref.
public void	disableRefLog() Don't record this update in the ref's associated reflog.
protected abstract RefUpdate.Result	Returns: `result` doDelete(RefUpdate.Result a `org.eclipse.jgit.lib.RefUpdate.Result` object. desiredResult) Do delete
protected abstract RefUpdate.Result	Returns: `org.eclipse.jgit.lib.RefUpdate.Result#NEW` on success. doLink(String a `java.lang.String` object. target) Do link
protected abstract RefUpdate.Result	Returns: `result` doUpdate(RefUpdate.Result a `org.eclipse.jgit.lib.RefUpdate.Result` object. desiredResult) Do update
public RefUpdate.Result	Returns: the result status of the update. forceUpdate() Force the ref to take the new value.
public ObjectId	Returns: the expected value of the ref after the lock is taken, but before update occurs. Null to avoid the compare and swap test. Use `org.eclipse.jgit.lib.ObjectId#zeroId()` to indicate expectation of a non-existant ref. getExpectedOldObjectId() Get the expected value of the ref after the lock is taken, but before update occurs.
public String	Returns: name of underlying ref. getName() Get the name of the ref this update will operate on.
public ObjectId	Returns: new value. Null if the caller has not configured it. getNewObjectId() Get the new value the ref will be (or was) updated to.
public ObjectId	Returns: the value of the ref prior to the update being attempted; null if the updated has not been attempted yet. getOldObjectId() The old value of the ref, prior to the update being attempted.
protected PushCertificate	Returns: push certificate, may be null. getPushCertificate() Set the push certificate associated with this update.
public Ref	Returns: the reference this update will create or modify. getRef() Get the reference this update will create or modify.
protected abstract RefDatabase	Returns: the reference database this update modifies. getRefDatabase() Get the reference database this update modifies.
public PersonIdent	Returns: identity of the user making the change in the reflog. getRefLogIdent() Get identity of the user making the change in the reflog.
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.
protected abstract Repository	Returns: the repository storing the database's objects. getRepository() Get the repository storing the database's objects.
public RefUpdate.Result	Returns: the status of the update. getResult() Get the status of this update.
public boolean	Returns: true if detaching a symref. isDetachingSymbolicRef() Return whether this update is actually detaching a symbolic ref.
protected boolean	Returns: whether force writing is enabled. isForceRefLog() Check whether the reflog should be written regardless of repo defaults.
public boolean	Returns: true if this update should ignore merge tests. isForceUpdate() Check if this update wants to forcefully change the ref.
protected boolean	Returns: `true` if the ref log message should show the result. isRefLogIncludingResult() Whether the ref log message should show the result.
public RefUpdate.Result	Returns: `org.eclipse.jgit.lib.RefUpdate.Result#NEW` or `org.eclipse.jgit.lib.RefUpdate.Result#FORCED` on success. link(String name of the new target for this reference. The new target name must be absolute, so it must begin with `refs/`. target) Replace this reference with a symbolic reference to another reference.
private void	requireCanDoUpdate()
private static RevObject	safeParseNew(RevWalk rw, AnyObjectId newId)
private static RevObject	safeParseOld(RevWalk rw, AnyObjectId oldId)
public void	setCheckConflicting(boolean whether to enable the check for conflicting ref names. check) Enable/disable the check for conflicting ref names.
public void	setDetachingSymbolicRef() Tells this RefUpdate that it is actually detaching a symbolic ref.
public void	setExpectedOldObjectId(AnyObjectId the expected value of the ref after the lock is taken, but before update occurs. Null to avoid the compare and swap test. Use `org.eclipse.jgit.lib.ObjectId#zeroId()` to indicate expectation of a non-existant ref. id) Set the expected value of the ref after the lock is taken, but before update occurs.
public void	setForceRefLog(boolean whether to force. force) Force writing a reflog for the updated ref.
public void	setForceUpdate(boolean true if this update should ignore merge tests. b) Set if this update wants to forcefully change the ref.
public void	setNewObjectId(AnyObjectId the new value. id) Set the new value the ref will update to.
protected void	setOldObjectId(ObjectId the old value. old) Set the old value of the ref.
public void	setPushCertificate(PushCertificate push certificate, may be null. cert) Set a push certificate associated with this update.
public void	setRefLogIdent(PersonIdent identity of the user. If null the identity will be automatically determined based on the repository configuration. pi) Set the identity of the user appearing in the reflog.
public void	setRefLogMessage(String the message to describe this change. It may be null if appendStatus is null in order not to append to the reflog 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.
protected abstract boolean	Returns: true if the lock was acquired and the reference is likely protected from concurrent modification; false if it failed. tryLock(boolean true if the lock should be taken against the leaf level reference; false if it should be taken exactly against the current reference. deref) Try to acquire the lock on the reference.
protected abstract void	unlock() Releases the lock taken by `tryLock` if it succeeded.
public RefUpdate.Result	Returns: the result status of the update. update() Gracefully update the ref to the new value.
public RefUpdate.Result	Returns: the result status of the update. update(RevWalk a RevWalk instance this update command can borrow to perform the merge test. The walk will be reset to perform the test. walk) Gracefully update the ref to the new value.
private RefUpdate.Result	updateImpl(RevWalk walk, RefUpdate.Store store)

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

Field Detail

checkConflicting	back to summary
private boolean checkConflicting

detachingSymbolicRef	back to summary
private boolean detachingSymbolicRef Is this RefUpdate detaching a symbolic ref? We need this info since this.ref will normally be peeled of in case of detaching a symbolic ref (HEAD for example). Without this flag we cannot decide whether the ref has to be updated or not in case when it was a symbolic ref and the newValue == oldValue.

expValue	back to summary
private ObjectId expValue If non-null, the value `oldValue` must have to continue.

force	back to summary
private boolean force Does this specification ask for forced updated (rewind/reset)?

forceRefLog	back to summary
private boolean forceRefLog Should reflogs be written even if the configured default for this ref is not to write it.

newValue	back to summary
private ObjectId newValue New value the caller wants this ref to have.

oldValue	back to summary
private ObjectId oldValue Old value of the ref, obtained after we lock it.

pushCert	back to summary
private PushCertificate pushCert Push certificate associated with this update.

ref	back to summary
private final Ref ref

refLogIdent	back to summary
private PersonIdent refLogIdent Identity to record action as within the reflog.

refLogIncludeResult	back to summary
private boolean refLogIncludeResult Should the Result value be appended to `refLogMessage`.

refLogMessage	back to summary
private String refLogMessage Message the caller wants included in the reflog.

result	back to summary
private RefUpdate.Result result Result of the update operation.

Constructor Detail

RefUpdate back to summary

RefUpdate	back to summary
protected RefUpdate(Ref ref) Construct a new update operation for the reference. `ref.getObjectId()` will be used to seed `getOldObjectId()`, which callers can use as part of their own update logic. Parameters ref:Ref the reference that will be updated by this operation.

protected RefUpdate(Ref ref)

Construct a new update operation for the reference.

ref.getObjectId() will be used to seed getOldObjectId(), which callers can use as part of their own update logic.

Parameters

ref:Ref: the reference that will be updated by this operation.

Method Detail

delete	back to summary
public RefUpdate.Result delete() throws IOException Delete the ref. This is the same as: return delete(new RevWalk(getRepository())); Returns:RefUpdate.Result the result status of the delete. Exceptions IOException: if an IO error occurred

delete

back to summary

public RefUpdate.Result delete() throws IOException

Delete the ref.

This is the same as:

return delete(new RevWalk(getRepository()));

Returns:RefUpdate.Result

the result status of the delete.

Exceptions

IOException:: if an IO error occurred

delete	back to summary
public RefUpdate.Result delete(RevWalk walk) throws IOException Delete the ref. Parameters walk:RevWalk a RevWalk instance this delete command can borrow to perform the merge test. The walk will be reset to perform the test. Returns:RefUpdate.Result the result status of the delete. Exceptions IOException: if an IO error occurred

delete

back to summary

public RefUpdate.Result delete(RevWalk walk) throws IOException

Delete the ref.

Parameters

walk:RevWalk: a RevWalk instance this delete command can borrow to perform the merge test. The walk will be reset to perform the test.

Returns:RefUpdate.Result

the result status of the delete.

Exceptions

IOException:: if an IO error occurred

disableRefLog	back to summary
public void disableRefLog() Don't record this update in the ref's associated reflog.

doDelete back to summary

doDelete	back to summary
protected abstract RefUpdate.Result doDelete(RefUpdate.Result desiredResult) throws IOException Do delete Parameters desiredResult:RefUpdate.Result a `org.eclipse.jgit.lib.RefUpdate.Result` object. Returns:RefUpdate.Result `result` Exceptions IOException: if an IO error occurred

protected abstract RefUpdate.Result doDelete(RefUpdate.Result desiredResult) throws IOException

Do delete

Parameters

desiredResult:RefUpdate.Result: a org.eclipse.jgit.lib.RefUpdate.Result object.

Returns:RefUpdate.Result

result

Exceptions

IOException:: if an IO error occurred

doLink back to summary

doLink	back to summary
protected abstract RefUpdate.Result doLink(String target) throws IOException Do link Parameters target:String a `java.lang.String` object. Returns:RefUpdate.Result `org.eclipse.jgit.lib.RefUpdate.Result#NEW` on success. Exceptions IOException: if an IO error occurred

protected abstract RefUpdate.Result doLink(String target) throws IOException

Do link

Parameters

target:String: a java.lang.String object.

Returns:RefUpdate.Result

org.eclipse.jgit.lib.RefUpdate.Result#NEW on success.

Exceptions

IOException:: if an IO error occurred

doUpdate back to summary

doUpdate	back to summary
protected abstract RefUpdate.Result doUpdate(RefUpdate.Result desiredResult) throws IOException Do update Parameters desiredResult:RefUpdate.Result a `org.eclipse.jgit.lib.RefUpdate.Result` object. Returns:RefUpdate.Result `result` Exceptions IOException: if an IO error occurred

protected abstract RefUpdate.Result doUpdate(RefUpdate.Result desiredResult) throws IOException

Do update

Parameters

desiredResult:RefUpdate.Result: a org.eclipse.jgit.lib.RefUpdate.Result object.

Returns:RefUpdate.Result

result

Exceptions

IOException:: if an IO error occurred

forceUpdate	back to summary
public RefUpdate.Result forceUpdate() throws IOException Force the ref to take the new value. This is just a convenient helper for setting the force flag, and as such the merge test is performed. Returns:RefUpdate.Result the result status of the update. Exceptions IOException: an unexpected IO error occurred while writing changes.

forceUpdate

back to summary

public RefUpdate.Result forceUpdate() throws IOException

Force the ref to take the new value.

This is just a convenient helper for setting the force flag, and as such the merge test is performed.

Returns:RefUpdate.Result

the result status of the update.

Exceptions

IOException:: an unexpected IO error occurred while writing changes.

getExpectedOldObjectId back to summary

getExpectedOldObjectId	back to summary
public ObjectId getExpectedOldObjectId() Get the expected value of the ref after the lock is taken, but before update occurs. Returns:ObjectId the expected value of the ref after the lock is taken, but before update occurs. Null to avoid the compare and swap test. Use `org.eclipse.jgit.lib.ObjectId#zeroId()` to indicate expectation of a non-existant ref.

public ObjectId getExpectedOldObjectId()

Get the expected value of the ref after the lock is taken, but before update occurs.

Returns:ObjectId: the expected value of the ref after the lock is taken, but before update occurs. Null to avoid the compare and swap test. Use org.eclipse.jgit.lib.ObjectId#zeroId() to indicate expectation of a non-existant ref.

getName	back to summary
public String getName() Get the name of the ref this update will operate on. Returns:String name of underlying ref.

getName

back to summary

public String getName()

Get the name of the ref this update will operate on.

Returns:String: name of underlying ref.

getNewObjectId	back to summary
public ObjectId getNewObjectId() Get the new value the ref will be (or was) updated to. Returns:ObjectId new value. Null if the caller has not configured it.

getNewObjectId

back to summary

public ObjectId getNewObjectId()

Get the new value the ref will be (or was) updated to.

Returns:ObjectId: new value. Null if the caller has not configured it.

getOldObjectId	back to summary
public ObjectId getOldObjectId() The old value of the ref, prior to the update being attempted. This value may differ before and after the update method. Initially it is populated with the value of the ref before the lock is taken, but the old value may change if someone else modified the ref between the time we last read it and when the ref was locked for update. Returns:ObjectId the value of the ref prior to the update being attempted; null if the updated has not been attempted yet.

getOldObjectId

back to summary

public ObjectId getOldObjectId()

The old value of the ref, prior to the update being attempted.

This value may differ before and after the update method. Initially it is populated with the value of the ref before the lock is taken, but the old value may change if someone else modified the ref between the time we last read it and when the ref was locked for update.

Returns:ObjectId: the value of the ref prior to the update being attempted; null if the updated has not been attempted yet.

getPushCertificate	back to summary
protected PushCertificate getPushCertificate() Set the push certificate associated with this update. This usually includes a command to update this ref, but is not required to. Returns:PushCertificate push certificate, may be null. Since 4.1

getPushCertificate

back to summary

protected PushCertificate getPushCertificate()

Set the push certificate associated with this update.

This usually includes a command to update this ref, but is not required to.

Returns:PushCertificate: push certificate, may be null.
Since: 4.1

getRef	back to summary
public Ref getRef() Get the reference this update will create or modify. Returns:Ref the reference this update will create or modify.

getRef

back to summary

public Ref getRef()

Get the reference this update will create or modify.

Returns:Ref: the reference this update will create or modify.

getRefDatabase	back to summary
protected abstract RefDatabase getRefDatabase() Get the reference database this update modifies. Returns:RefDatabase the reference database this update modifies.

getRefDatabase

back to summary

protected abstract RefDatabase getRefDatabase()

Get the reference database this update modifies.

Returns:RefDatabase: the reference database this update modifies.

getRefLogIdent	back to summary
public PersonIdent getRefLogIdent() Get identity of the user making the change in the reflog. Returns:PersonIdent identity of the user making the change in the reflog.

getRefLogIdent

back to summary

public PersonIdent getRefLogIdent()

Get identity of the user making the change in the reflog.

Returns:PersonIdent: identity of the user making the change in the reflog.

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.

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.

getRepository	back to summary
protected abstract Repository getRepository() Get the repository storing the database's objects. Returns:Repository the repository storing the database's objects.

getRepository

back to summary

protected abstract Repository getRepository()

Get the repository storing the database's objects.

Returns:Repository: the repository storing the database's objects.

getResult	back to summary
public RefUpdate.Result getResult() Get the status of this update. The same value that was previously returned from an update method. Returns:RefUpdate.Result the status of the update.

getResult

back to summary

public RefUpdate.Result getResult()

Get the status of this update.

The same value that was previously returned from an update method.

Returns:RefUpdate.Result: the status of the update.

isDetachingSymbolicRef	back to summary
public boolean isDetachingSymbolicRef() Return whether this update is actually detaching a symbolic ref. Returns:boolean true if detaching a symref. Since 4.9

isDetachingSymbolicRef

back to summary

public boolean isDetachingSymbolicRef()

Return whether this update is actually detaching a symbolic ref.

Returns:boolean: true if detaching a symref.
Since: 4.9

isForceRefLog	back to summary
protected boolean isForceRefLog() Check whether the reflog should be written regardless of repo defaults. Returns:boolean whether force writing is enabled. Since 4.9

isForceRefLog

back to summary

protected boolean isForceRefLog()

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

Returns:boolean: whether force writing is enabled.
Since: 4.9

isForceUpdate	back to summary
public boolean isForceUpdate() Check if this update wants to forcefully change the ref. Returns:boolean true if this update should ignore merge tests.

isForceUpdate

back to summary

public boolean isForceUpdate()

Check if this update wants to forcefully change the ref.

Returns:boolean: true if this update should ignore merge tests.

isRefLogIncludingResult back to summary

isRefLogIncludingResult	back to summary
protected boolean isRefLogIncludingResult() Whether the ref log message should show the result. Returns:boolean `true` if the ref log message should show the result.

protected boolean isRefLogIncludingResult()

Whether the ref log message should show the result.

Returns:boolean: true if the ref log message should show the result.

link back to summary

link	back to summary
public RefUpdate.Result link(String target) throws IOException Replace this reference with a symbolic reference to another reference. This exact reference (not its traversed leaf) is replaced with a symbolic reference to the requested name. Parameters target:String name of the new target for this reference. The new target name must be absolute, so it must begin with `refs/`. Returns:RefUpdate.Result `org.eclipse.jgit.lib.RefUpdate.Result#NEW` or `org.eclipse.jgit.lib.RefUpdate.Result#FORCED` on success. Exceptions IOException: if an IO error occurred

public RefUpdate.Result link(String target) throws IOException

Replace this reference with a symbolic reference to another reference.

This exact reference (not its traversed leaf) is replaced with a symbolic reference to the requested name.

Parameters

target:String: name of the new target for this reference. The new target name must be absolute, so it must begin with refs/.

Returns:RefUpdate.Result

org.eclipse.jgit.lib.RefUpdate.Result#NEW or org.eclipse.jgit.lib.RefUpdate.Result#FORCED on success.

Exceptions

IOException:: if an IO error occurred

requireCanDoUpdate	back to summary
private void requireCanDoUpdate()

safeParseNew	back to summary
private static RevObject safeParseNew(RevWalk rw, AnyObjectId newId) throws IOException

safeParseOld	back to summary
private static RevObject safeParseOld(RevWalk rw, AnyObjectId oldId) throws IOException

setCheckConflicting	back to summary
public void setCheckConflicting(boolean check) Enable/disable the check for conflicting ref names. By default conflicts are checked explicitly. Parameters check:boolean whether to enable the check for conflicting ref names. Since 3.0

setCheckConflicting

back to summary

public void setCheckConflicting(boolean check)

Enable/disable the check for conflicting ref names. By default conflicts are checked explicitly.

Parameters

check:boolean: whether to enable the check for conflicting ref names.

Since

3.0

setDetachingSymbolicRef	back to summary
public void setDetachingSymbolicRef() Tells this RefUpdate that it is actually detaching a symbolic ref.

setExpectedOldObjectId back to summary

setExpectedOldObjectId	back to summary
public void setExpectedOldObjectId(AnyObjectId id) Set the expected value of the ref after the lock is taken, but before update occurs. Parameters id:AnyObjectId the expected value of the ref after the lock is taken, but before update occurs. Null to avoid the compare and swap test. Use `org.eclipse.jgit.lib.ObjectId#zeroId()` to indicate expectation of a non-existant ref.

public void setExpectedOldObjectId(AnyObjectId id)

Set the expected value of the ref after the lock is taken, but before update occurs.

Parameters

id:AnyObjectId: the expected value of the ref after the lock is taken, but before update occurs. Null to avoid the compare and swap test. Use org.eclipse.jgit.lib.ObjectId#zeroId() to indicate expectation of a non-existant ref.

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

setForceUpdate	back to summary
public void setForceUpdate(boolean b) Set if this update wants to forcefully change the ref. Parameters b:boolean true if this update should ignore merge tests.

setForceUpdate

back to summary

public void setForceUpdate(boolean b)

Set if this update wants to forcefully change the ref.

Parameters

b:boolean: true if this update should ignore merge tests.

setNewObjectId	back to summary
public void setNewObjectId(AnyObjectId id) Set the new value the ref will update to. Parameters id:AnyObjectId the new value.

setNewObjectId

back to summary

public void setNewObjectId(AnyObjectId id)

Set the new value the ref will update to.

Parameters

id:AnyObjectId: the new value.

setOldObjectId

back to summary

protected void setOldObjectId(ObjectId old)

Set the old value of the ref.

Parameters

old:ObjectId: the old value.

setPushCertificate

back to summary

public void setPushCertificate(PushCertificate cert)

Set a push certificate associated with this update.

This usually includes a command to update this ref, but is not required to.

Parameters

cert:PushCertificate: push certificate, may be null.

Since

4.1

setRefLogIdent

back to summary

public void setRefLogIdent(PersonIdent pi)

Set the identity of the user appearing in the reflog.

The timestamp portion of the identity is ignored. A new identity with the current timestamp will be created automatically when the update occurs and the log record is written.

Parameters

pi:PersonIdent: identity of the user. If null the identity will be automatically determined based on the repository configuration.

setRefLogMessage back to summary

public void setRefLogMessage(String msg, boolean appendStatus)

Set the message to include in the reflog.

Repository implementations may limit which reflogs are written by default, based on the project configuration. If a repo is not configured to write logs for this ref by default, setting the message alone may have no effect. To indicate that the repo should write logs for this update in spite of configured defaults, use setForceRefLog(boolean).

Parameters

msg:String: the message to describe this change. It may be null if appendStatus is null in order not to append to the reflog
appendStatus:boolean: true if the status of the ref change (fast-forward or forced-update) should be appended to the user supplied message.

tryLock back to summary

protected abstract boolean tryLock(boolean deref) throws IOException

Try to acquire the lock on the reference.

If the locking was successful the implementor must set the current identity value by calling setOldObjectId(ObjectId).

Parameters

deref:boolean: true if the lock should be taken against the leaf level reference; false if it should be taken exactly against the current reference.

Returns:boolean

true if the lock was acquired and the reference is likely protected from concurrent modification; false if it failed.

Exceptions

IOException:: the lock couldn't be taken due to an unexpected storage failure, and not because of a concurrent update.

unlock	back to summary
protected abstract void unlock() Releases the lock taken by `tryLock` if it succeeded.

update back to summary

public RefUpdate.Result update() throws IOException

Gracefully update the ref to the new value.

Merge test will be performed according to isForceUpdate().

This is the same as:

return update(new RevWalk(getRepository()));

Returns:RefUpdate.Result

the result status of the update.

Exceptions

IOException:: an unexpected IO error occurred while writing changes.

update back to summary

public RefUpdate.Result update(RevWalk walk) throws IOException

Gracefully update the ref to the new value.

Merge test will be performed according to isForceUpdate().

Parameters

walk:RevWalk: a RevWalk instance this update command can borrow to perform the merge test. The walk will be reset to perform the test.

Returns:RefUpdate.Result

the result status of the update.

Exceptions

IOException:: an unexpected IO error occurred while writing changes.

updateImpl	back to summary
private RefUpdate.Result updateImpl(RevWalk walk, RefUpdate.Store store) throws IOException

org.eclipse.jgit.lib back to summary

public final Enum RefUpdate.Result

Class Inheritance

extends Enum<RefUpdate.Result>

java.lang.Object
java.lang.Enum
org.eclipse.jgit.lib.RefUpdate.Result

Status of an update request.

New values may be added to this enum in the future. Callers may assume that unknown values are failures, and may generally treat them the same as REJECTED_OTHER_REASON.

Field Summary

Modifier and Type	Field and Description
public static final RefUpdate.Result	FAST_FORWARD The ref was updated/deleted in a fast-forward way.
public static final RefUpdate.Result	FORCED The ref had to be forcefully updated/deleted.
public static final RefUpdate.Result	IO_FAILURE The ref was probably not updated/deleted because of I/O error.
public static final RefUpdate.Result	LOCK_FAILURE The ref could not be locked for update/delete.
public static final RefUpdate.Result	NEW The ref was created locally for an update, but ignored for delete.
public static final RefUpdate.Result	NO_CHANGE Same value already stored.
public static final RefUpdate.Result	NOT_ATTEMPTED The ref update/delete has not been attempted by the caller.
public static final RefUpdate.Result	REJECTED Not a fast-forward and not stored.
public static final RefUpdate.Result	REJECTED_CURRENT_BRANCH Rejected because trying to delete the current branch.
public static final RefUpdate.Result	REJECTED_MISSING_OBJECT One or more objects aren't in the repository.
public static final RefUpdate.Result	REJECTED_OTHER_REASON Rejected for some other reason not covered by another enum value.
public static final RefUpdate.Result	RENAMED The ref was renamed from another name

Constructor Summary

Access	Constructor and Description
private	Result()

Method Summary

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

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

Field Detail

FAST_FORWARD

back to summary

public static final RefUpdate.Result FAST_FORWARD

The ref was updated/deleted in a fast-forward way.

The tracking ref already existed and its old value was fully merged into the new value. No history was made unreachable.

FORCED

back to summary

public static final RefUpdate.Result FORCED

The ref had to be forcefully updated/deleted.

The ref already existed but its old value was not fully merged into the new value. The configuration permitted a forced update to take place, so ref now contains the new value. History associated with the objects not merged may no longer be reachable.

IO_FAILURE back to summary

public static final RefUpdate.Result IO_FAILURE

The ref was probably not updated/deleted because of I/O error.

Unexpected I/O error occurred when writing new ref. Such error may result in uncertain state, but most probably ref was not updated.

This kind of error doesn't include LOCK_FAILURE, which is a different case.

LOCK_FAILURE

back to summary

public static final RefUpdate.Result LOCK_FAILURE

The ref could not be locked for update/delete.

This is generally a transient failure and is usually caused by another process trying to access the ref at the same time as this process was trying to update it. It is possible a future operation will be successful.

NEW

back to summary

public static final RefUpdate.Result NEW

The ref was created locally for an update, but ignored for delete.

The ref did not exist when the update started, but it was created successfully with the new value.

NO_CHANGE

back to summary

public static final RefUpdate.Result NO_CHANGE

Same value already stored.

Both the old value and the new value are identical. No change was necessary for an update. For delete the branch is removed.

NOT_ATTEMPTED	back to summary
public static final RefUpdate.Result NOT_ATTEMPTED The ref update/delete has not been attempted by the caller.

REJECTED back to summary

public static final RefUpdate.Result REJECTED

Not a fast-forward and not stored.

The tracking ref already existed but its old value was not fully merged into the new value. The configuration did not allow a forced update/delete to take place, so ref still contains the old value. No previous history was lost.

Note

Despite the general name, this result only refers to the non-fast-forward case. For more general errors, see REJECTED_OTHER_REASON.

REJECTED_CURRENT_BRANCH

back to summary

public static final RefUpdate.Result REJECTED_CURRENT_BRANCH

Rejected because trying to delete the current branch.

Has no meaning for update.

REJECTED_MISSING_OBJECT

back to summary

public static final RefUpdate.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.

Since: 4.9

REJECTED_OTHER_REASON

back to summary

public static final RefUpdate.Result REJECTED_OTHER_REASON

Rejected for some other reason not covered by another enum value.

Since: 4.9

RENAMED	back to summary
public static final RefUpdate.Result RENAMED The ref was renamed from another name

Constructor Detail

Result	back to summary
private Result()

Method Detail

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

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

public abstract Class RefUpdate

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum RefUpdate.Result

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private abstract Class RefUpdate.Store

Constructor Summary

Method Summary

Constructor Detail

Method Detail