Improved documentation

This commit is contained in:
leventov
2015-05-27 04:30:58 +01:00
parent b4c8554b77
commit 4fb73bb821
28 changed files with 319 additions and 42 deletions
@@ -2,7 +2,23 @@ package net.openhft.chronicle.set;
import net.openhft.chronicle.hash.HashEntry;
/**
* The <i>present</i> {@link ChronicleSet} entry context.
*
* @param <K> the set key type
* @see SetEntryOperations
* @see SetQueryContext#entry()
*/
public interface SetEntry<K> extends HashEntry<K> {
@Override
SetContext<K, ?> context();
/**
* Removes the entry from the {@code ChronicleSet}.
*
* <p>This method is the default implementation for {@link SetEntryOperations#remove(SetEntry)},
* which might be customized over the default.
*/
@Override
void doRemove();
}