Interface CommitContext
- All Known Implementing Classes:
SimpleCommitContext
public interface CommitContext
A CommitContext instance can be obtained from
CommitInfo.getInfo()
if it has been set before the merge call. This can then be used by CommitHook
to record some metadata regarding the commit.
CommitContext state would be reset in case commit is retried from within NodeStore say when a merge exception occurs.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Name of the entry of the mutable commit attributes map in theinfo
map inCommitInfo.getInfo()
-
Method Summary
Modifier and TypeMethodDescription@Nullable Object
Returns the value of the named attribute as anObject
, ornull
if no attribute of the given name exists.void
Removes an attribute from this commit.void
Stores an attribute related to this commit.
-
Field Details
-
NAME
Name of the entry of the mutable commit attributes map in theinfo
map inCommitInfo.getInfo()
- See Also:
-
-
Method Details
-
set
Stores an attribute related to this commit. Attributes are reset if the commit is retried.If the object passed in is null, the effect is the same as calling
remove(java.lang.String)
.- Parameters:
name
- aString
specifying the name of the attributevalue
- theObject
to be stored
-
get
Returns the value of the named attribute as anObject
, ornull
if no attribute of the given name exists.- Parameters:
name
-String
specifying the name of the attribute- Returns:
- an
Object
containing the value of the attribute, ornull
if the attribute does not exist
-
remove
Removes an attribute from this commit.- Parameters:
name
- aString
specifying the name of the attribute to remove
-