Interface CommitContext
-
- All Known Implementing Classes:
SimpleCommitContext
public interface CommitContext
A CommitContext instance can be obtained fromCommitInfo.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
Fields Modifier and Type Field Description static java.lang.String
NAME
Name of the entry of the mutable commit attributes map in theinfo
map inCommitInfo.getInfo()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @Nullable java.lang.Object
get(java.lang.String name)
Returns the value of the named attribute as anObject
, ornull
if no attribute of the given name exists.void
remove(java.lang.String name)
Removes an attribute from this commit.void
set(java.lang.String name, java.lang.Object value)
Stores an attribute related to this commit.
-
-
-
Field Detail
-
NAME
static final java.lang.String NAME
Name of the entry of the mutable commit attributes map in theinfo
map inCommitInfo.getInfo()
- See Also:
- Constant Field Values
-
-
Method Detail
-
set
void set(java.lang.String name, java.lang.Object value)
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
@Nullable @Nullable java.lang.Object get(java.lang.String name)
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
void remove(java.lang.String name)
Removes an attribute from this commit.- Parameters:
name
- aString
specifying the name of the attribute to remove
-
-