|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.jgit.lib.RefUpdate
public class RefUpdate
Updates any locally stored ref.
| Nested Class Summary | |
|---|---|
static class |
RefUpdate.Result
Status of an update request. |
| Method Summary | |
|---|---|
RefUpdate.Result |
delete()
Delete the ref. |
RefUpdate.Result |
delete(RevWalk walk)
Delete the ref. |
void |
disableRefLog()
Don't record this update in the ref's associated reflog. |
RefUpdate.Result |
forceUpdate()
Force the ref to take the new value. |
ObjectId |
getExpectedOldObjectId()
|
java.lang.String |
getName()
Get the name of the ref this update will operate on. |
ObjectId |
getNewObjectId()
Get the new value the ref will be (or was) updated to. |
ObjectId |
getOldObjectId()
The old value of the ref, prior to the update being attempted. |
java.lang.String |
getOrigName()
Get the requested name of the ref thit update will operate on |
PersonIdent |
getRefLogIdent()
|
java.lang.String |
getRefLogMessage()
Get the message to include in the reflog. |
Repository |
getRepository()
|
RefUpdate.Result |
getResult()
Get the status of this update. |
boolean |
isForceUpdate()
Check if this update wants to forcefully change the ref. |
void |
setExpectedOldObjectId(AnyObjectId id)
|
void |
setForceUpdate(boolean b)
Set if this update wants to forcefully change the ref. |
void |
setNewObjectId(AnyObjectId id)
Set the new value the ref will update to. |
void |
setRefLogIdent(PersonIdent pi)
Set the identity of the user appearing in the reflog. |
void |
setRefLogMessage(java.lang.String msg,
boolean appendStatus)
Set the message to include in the reflog. |
RefUpdate.Result |
update()
Gracefully update the ref to the new value. |
RefUpdate.Result |
update(RevWalk walk)
Gracefully update the ref to the new value. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public Repository getRepository()
public java.lang.String getName()
public java.lang.String getOrigName()
public ObjectId getNewObjectId()
public void setNewObjectId(AnyObjectId id)
id - the new value.public ObjectId getExpectedOldObjectId()
ObjectId.zeroId() to indicate expectation of a
non-existant ref.public void setExpectedOldObjectId(AnyObjectId id)
id - the expected value of the ref after the lock is taken, but
before update occurs. Null to avoid the compare and swap test.
Use ObjectId.zeroId() to indicate expectation of a
non-existant ref.public boolean isForceUpdate()
public void setForceUpdate(boolean b)
b - true if this update should ignore merge tests.public PersonIdent getRefLogIdent()
public void setRefLogIdent(PersonIdent pi)
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.
pi - identity of the user. If null the identity will be
automatically determined based on the repository
configuration.public java.lang.String getRefLogMessage()
public void setRefLogMessage(java.lang.String msg,
boolean appendStatus)
msg - the message to describe this change. It may be null
if appendStatus is null in order not to append to the reflogappendStatus - true if the status of the ref change (fast-forward or
forced-update) should be appended to the user supplied
message.public void disableRefLog()
public ObjectId getOldObjectId()
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.
public RefUpdate.Result getResult()
The same value that was previously returned from an update method.
public RefUpdate.Result forceUpdate()
throws java.io.IOException
This is just a convenient helper for setting the force flag, and as such the merge test is performed.
java.io.IOException - an unexpected IO error occurred while writing changes.
public RefUpdate.Result update()
throws java.io.IOException
Merge test will be performed according to isForceUpdate().
This is the same as:
return update(new RevWalk(repository));
java.io.IOException - an unexpected IO error occurred while writing changes.
public RefUpdate.Result update(RevWalk walk)
throws java.io.IOException
Merge test will be performed according to isForceUpdate().
walk - a RevWalk instance this update command can borrow to perform
the merge test. The walk will be reset to perform the test.
java.io.IOException - an unexpected IO error occurred while writing changes.
public RefUpdate.Result delete()
throws java.io.IOException
This is the same as:
return delete(new RevWalk(repository));
java.io.IOException
public RefUpdate.Result delete(RevWalk walk)
throws java.io.IOException
walk - a RevWalk instance this delete command can borrow to perform
the merge test. The walk will be reset to perform the test.
java.io.IOException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||