mirror of
https://github.com/OpenHFT/Chronicle-Map.git
synced 2021-09-13 01:26:12 +00:00
Improve documentation
This commit is contained in:
@@ -108,7 +108,9 @@ public interface MapEntryOperations<K, V, R> {
|
||||
* @implNote default implementation calls {@link MapEntry#doRemove()} on the given entry
|
||||
* and returns {@code null}.
|
||||
*
|
||||
* @param entry the entry to remove
|
||||
* @param entry the entry to remove
|
||||
* @return result of operation, understandable by higher-level SPIs, e. g. custom
|
||||
* {@link MapMethods} implementation
|
||||
* @throws IllegalStateException if some locking/state conditions required to perform remove
|
||||
* operation are not met
|
||||
* @throws RuntimeException if removal was unconditionally unsuccessful due to any reason
|
||||
@@ -125,6 +127,8 @@ public interface MapEntryOperations<K, V, R> {
|
||||
* entry.doReplaceValue(newValue)} and returns {@code null}.
|
||||
*
|
||||
* @param entry the entry to replace the value in
|
||||
* @return result of operation, understandable by higher-level SPIs, e. g. custom
|
||||
* {@link MapMethods} implementation
|
||||
* @throws IllegalStateException if some locking/state conditions required to perform replace
|
||||
* operation are not met
|
||||
* @throws RuntimeException if value replacement was unconditionally unsuccessful due
|
||||
@@ -142,6 +146,8 @@ public interface MapEntryOperations<K, V, R> {
|
||||
* @implNote default implementation calls {@link MapAbsentEntry#doInsert(Data)
|
||||
* absentEntry.doInsert(value)} and returns {@code null}.
|
||||
*
|
||||
* @return result of operation, understandable by higher-level SPIs, e. g. custom
|
||||
* {@link MapMethods} implementation
|
||||
* @throws IllegalStateException if some locking/state conditions required to perform insertion
|
||||
* operation are not met
|
||||
* @throws RuntimeException if insertion was unconditionally unsuccessful due to any reason
|
||||
|
||||
Reference in New Issue
Block a user