From 52130fa9180a6bbce1082dfed15a24cf08d3e9bc Mon Sep 17 00:00:00 2001 From: Rob Austin Date: Thu, 13 Nov 2014 11:04:40 +0000 Subject: [PATCH] improved javadoc --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6c5b08040..9264d1fbf 100644 --- a/README.md +++ b/README.md @@ -310,14 +310,14 @@ the ChronicleMapBuilder can also be used to return the ChronicleMap, see the exa ChronicleMap map = ChronicleMapBuilder.of(Integer.class, CharSequence.class).create(); ``` -One way to achieve good performance is to focus on unnecessary object creation as this reduces +One way to achieve good performance is to focus on unnecessary object creation, as this reduces the amount of work that has to be carried out by the Garbage Collector. As such ChronicleMap supports the following methods : - [`V getUsing(K key, V value);`](http://openhft.github.io/Chronicle-Map/apidocs/net/openhft/chronicle/map/ChronicleMap.html#getUsing-K-V-) - [`V acquireUsing(K key, V value);`](http://openhft.github.io/Chronicle-Map/apidocs/net/openhft/chronicle/map/ChronicleMap.html#acquireUsing-K-V-) - - ReadContext getUsingLocked(@NotNull K key, @NotNull V usingValue); - - WriteContext acquireUsingLocked(@NotNull K key, @NotNull V usingValue); + - [`ReadContext getUsingLocked(@NotNull K key, @NotNull V usingValue);`] (https://github.com/OpenHFT/Chronicle-Map#off-heap-storage-and-how-using-a-proxy-object-can-improve-performance) + - [`WriteContext acquireUsingLocked(@NotNull K key, @NotNull V usingValue);`] (https://github.com/OpenHFT/Chronicle-Map#acquireusinglocked) These methods let you provide the object which the data will be written to, even if the object is