Alawn/Chronicle-Map
1
0
Fork 0
mirror of https://github.com/OpenHFT/Chronicle-Map.git synced 2021-09-13 01:26:12 +00:00
Code Releases Activity

added javadoc to newValueInstance and newKeyInstance

Browse Source
This commit is contained in:
Rob Austin
2015-01-01 09:52:19 +00:00
parent 8bb52ea6a1
commit 064fdb0ad2
1 changed files with 46 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/main/java/net/openhft/chronicle/map/ChronicleMap.java
+46
View File
@@ -241,12 +241,58 @@ public interface ChronicleMap<K, V> extends ConcurrentMap<K, V>, ChronicleHash {
void putAll(File fromFile) throws IOException;
/**
* Creates an empty value instance, which can be used with the
* following methods :
*
* {@link ChronicleMap#getUsing(java.lang.Object, java.lang.Object) }
* {@link ChronicleMap#getUsingLocked(java.lang.Object, java.lang.Object) }
* {@link ChronicleMap#acquireUsing(java.lang.Object, java.lang.Object) }
* {@link ChronicleMap#acquireUsingLocked(java.lang.Object, java.lang.Object) }
*
* for example like this :
*
* <pre>{@code
* V value = map.newValueInstance();
* try (ReadContext rc = map.getUsingLocked(key, value)) {
* // add your logic here
* } // the read lock is released here
* }</pre>
*
*
* @return a new empty instance based on the Value type
* @see ChronicleMap#getUsing(java.lang.Object, java.lang.Object)
* @see ChronicleMap#getUsingLocked(java.lang.Object, java.lang.Object)
* @see ChronicleMap#acquireUsing(java.lang.Object, java.lang.Object)
* @see ChronicleMap#acquireUsingLocked(java.lang.Object, java.lang.Object)
*/
V newValueInstance();
/**
* Creates an empty value instance, which can be used with the
* following methods :
*
* {@link ChronicleMap#getUsing(java.lang.Object, java.lang.Object) }
* {@link ChronicleMap#getUsingLocked(java.lang.Object, java.lang.Object) }
* {@link ChronicleMap#acquireUsing(java.lang.Object, java.lang.Object) }
* {@link ChronicleMap#acquireUsingLocked(java.lang.Object, java.lang.Object) }
*
* for example like this :
*
* <pre>{@code
* K key = map.newKeyInstance();
* key.setMyStringField("some key");
*
* try (ReadContext rc = map.getUsingLocked(key, value)) {
* // add your logic here
* } // the read lock is released here
* }</pre>
*
*
* @return a new empty instance based on the Key type
* @see ChronicleMap#getUsing(java.lang.Object, java.lang.Object)
* @see ChronicleMap#getUsingLocked(java.lang.Object, java.lang.Object)
* @see ChronicleMap#acquireUsing(java.lang.Object, java.lang.Object)
* @see ChronicleMap#acquireUsingLocked(java.lang.Object, java.lang.Object)
*/
K newKeyInstance();