Make directory names more readable.

Author: aaronriekenberg

examples/map/README.md

@@ -1,25 +1,24 @@
 # map examples
 
-## OnHeapDemo
+## onheap
 
 * Put 20,000 CacheObject instances into a ConcurrentHashMap.
 * Each CacheObject instance contains a random string of length 500KB.
 * This is a total of 10 GB of data stored on the normal Java heap.
 * This application does not make use of any features of the native_memory_allocator library. It is provided for
   comparison with NativeMemoryMap demos using off-heap storage.
 
-## OffHeapDemo
+## offheap
 
-* Put 20,000 CacheObject instances into a NativeMemoryMap.
-* This demo uses the ConcurrentHashMap backend for NativeMemoryMap, which does not support eviction.
-* Each CacheObject instance contains a random string of length 500KB.
-* This is a total of 10 GB of data in off-heap memory.
+* Same as onheap but uses NativeMemoryMap with off-heap storage.
+* Uses the ConcurrentHashMap backend for NativeMemoryMap, which does not support eviction.
+* Total of 10 GB of data in off-heap memory.
 
-## OffHeapDemoWithEviction
+## offheap-eviction
 
-* Same as OffHeapDemo but uses the Caffeine backend with maximumSize of 10,000 entries.
+* Same as offheap but uses the Caffeine backend with maximumSize of 10,000 entries.
 * Expect 10,000 entries at end of run with 10,000 total evictions.
 
-## OffHeapDemoWithEvictionAndOperationCounters
+## offheap-eviction-operationcounters
 
-* Same as OffHeapDemoWithEviction but enables operation counters and logs them at the end of the demo.
+* Same as offheap-eviction but enables operation counters and logs them at the end of the demo.

examples/map/offheapdemo/build.gradle.kts renamed to examples/map/offheap-eviction-operationcounters/build.gradle.kts

@@ -1,4 +1,4 @@
-package com.target.nativememoryallocator.examples.map.offheapdemowithevictionandoperationcounters
+package com.target.nativememoryallocator.examples.map.offheap.eviction.operationcounters
 
 import com.target.nativememoryallocator.allocator.NativeMemoryAllocatorBuilder
 import com.target.nativememoryallocator.examples.map.utils.CacheObject
@@ -14,9 +14,9 @@ private val logger = KotlinLogging.logger {}
 
 
 /**
- * Same as OffHeapDemoWithEviction but enables operation counters
+ * Same as OffHeapEviction but enables operation counters
  */
-private class OffHeapDemoWithEvictionAndOperationCounters {
+private class OffHeapEvictionOperationCounters {
 
     private val numEntries = 20_000
 
@@ -90,6 +90,6 @@ private class OffHeapDemoWithEvictionAndOperationCounters {
 
 suspend fun main() {
     withContext(Dispatchers.Default) {
-        OffHeapDemoWithEvictionAndOperationCounters().run()
+        OffHeapEvictionOperationCounters().run()
     }
 }

examples/map/offheapdemowithevictionandoperationcounters/src/main/kotlin/com/target/nativememoryallocator/examples/map/offheapdemowithevictionandoperationcounters/OffHeapDemoWithEvictionAndOperationCounters.kt renamed to examples/map/offheap-eviction-operationcounters/src/main/kotlin/com/target/nativememoryallocator/examples/map/offheap.eviction.operationcounters/OffHeapEvictionOperationCounters.kt

@@ -1,4 +1,4 @@
-package com.target.nativememoryallocator.examples.map.offheapdemowitheviction
+package com.target.nativememoryallocator.examples.map.offheap.eviction
 
 import com.target.nativememoryallocator.allocator.NativeMemoryAllocatorBuilder
 import com.target.nativememoryallocator.examples.map.utils.CacheObject
@@ -14,9 +14,9 @@ private val logger = KotlinLogging.logger {}
 
 
 /**
- * Same as OffHeapDemo but uses the Caffeine backend with maximumSize of 10,000 entries.
+ * Same as OffHeap but uses the Caffeine backend with maximumSize of 10,000 entries.
  */
-private class OffHeapDemoWithEviction {
+private class OffHeapEviction {
 
     private val numEntries = 20_000
 
@@ -87,6 +87,6 @@ private class OffHeapDemoWithEviction {
 
 suspend fun main() {
     withContext(Dispatchers.Default) {
-        OffHeapDemoWithEviction().run()
+        OffHeapEviction().run()
     }
 }

examples/map/offheapdemowitheviction/build.gradle.kts renamed to examples/map/offheap-eviction/build.gradle.kts

@@ -1,4 +1,4 @@
-package com.target.nativememoryallocator.examples.map.offheapdemo
+package com.target.nativememoryallocator.examples.map.offheap
 
 import com.target.nativememoryallocator.allocator.NativeMemoryAllocatorBuilder
 import com.target.nativememoryallocator.examples.map.utils.CacheObject
@@ -22,9 +22,9 @@ private val logger = KotlinLogging.logger {}
  *
  * This is a total of 10 GB of data in off-heap memory.
  *
- * OnHeapDemo is the same application using normal on-heap storage for comparison.
+ * OnHeap is the same application using normal on-heap storage for comparison.
  */
-private class OffHeapDemo {
+private class OffHeap {
 
     private val numEntries = 20_000
 
@@ -88,6 +88,6 @@ private class OffHeapDemo {
 
 suspend fun main() {
     withContext(Dispatchers.Default) {
-        OffHeapDemo().run()
+        OffHeap().run()
     }
 }

examples/map/offheapdemowitheviction/src/main/kotlin/com/target/nativememoryallocator/examples/map/offheapdemowitheviction/OffHeapDemoWithEviction.kt renamed to examples/map/offheap-eviction/src/main/kotlin/com/target/nativememoryallocator/examples/map/offheap.eviction/OffHeapEviction.kt

@@ -1,4 +1,4 @@
-package com.target.nativememoryallocator.examples.map.onheapdemo
+package com.target.nativememoryallocator.examples.map.onheap
 
 import com.target.nativememoryallocator.examples.map.utils.CacheObject
 import com.target.nativememoryallocator.examples.map.utils.buildRandomString
@@ -19,7 +19,7 @@ private val logger = KotlinLogging.logger {}
  * This application does not make use of any features of the native_memory_allocator library.
  * It is provided for comparison with off-heap demos.
  */
-private class OnHeapDemo {
+private class OnHeap {
 
     private val numEntries = 20_000
 
@@ -70,6 +70,6 @@ private class OnHeapDemo {
 
 suspend fun main() {
     withContext(Dispatchers.Default) {
-        OnHeapDemo().run()
+        OnHeap().run()
     }
 }

examples/map/offheapdemowithevictionandoperationcounters/build.gradle.kts renamed to examples/map/offheap/build.gradle.kts

@@ -4,8 +4,8 @@ include(
     "examples",
     "examples:map",
     "examples:map:utils",
-    "examples:map:onheapdemo",
-    "examples:map:offheapdemo",
-    "examples:map:offheapdemowitheviction",
-    "examples:map:offheapdemowithevictionandoperationcounters",
+    "examples:map:onheap",
+    "examples:map:offheap",
+    "examples:map:offheap-eviction",
+    "examples:map:offheap-eviction-operationcounters",
 )