Make examples/map subdirectory containing map examples. This allows for more subdirectories under examples if needed in future.

Author: aaronriekenberg

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

@@ -0,0 +1,3 @@
+rootProject.name = "native_memory_allocator"
+
+include("map")

examples/map/settings.gradle.kts

@@ -0,0 +1,8 @@
+package com.target.nativememoryallocator.examples.map
+
+/**
+ * A demo cache object containing a single field [s] of type [String].
+ */
+data class CacheObject(
+    val s: String,
+)

examples/map/src/main/kotlin/com/target/nativememoryallocator/examples/map/CacheObject.kt

@@ -1,4 +1,4 @@
-package com.target.nativememoryallocator.examples
+package com.target.nativememoryallocator.examples.map
 
 import com.target.nativememoryallocator.allocator.NativeMemoryAllocatorBuilder
 import com.target.nativememoryallocator.buffer.OnHeapMemoryBuffer
@@ -11,22 +11,15 @@ import kotlin.random.Random
 
 private val logger = KotlinLogging.logger {}
 
-private class CacheObjectSerializer : NativeMemoryMapSerializer<CacheObject> {
-
-    override fun deserializeFromOnHeapMemoryBuffer(onHeapMemoryBuffer: OnHeapMemoryBuffer): CacheObject {
-        return CacheObject(
-            s = String(onHeapMemoryBuffer.toTrimmedArray()),
-        )
-    }
-
-    override fun serializeToByteArray(value: CacheObject): ByteArray {
-        return value.s.toByteArray()
-    }
-
-}
 
 /**
  * Demo application that puts 20,000 [CacheObject] instances into a [NativeMemoryMap].
+ *
+ * Each [CacheObject] instances contains a random string of length 500KB.
+ *
+ * This is a total of 10 GB of data.
+ *
+ * [OnHeapDemo] is the same application using normal on-heap storage for comparison.
  */
 class OffHeapDemo {
 
@@ -90,6 +83,20 @@ class OffHeapDemo {
 
 }
 
+private class CacheObjectSerializer : NativeMemoryMapSerializer<CacheObject> {
+
+    override fun deserializeFromOnHeapMemoryBuffer(onHeapMemoryBuffer: OnHeapMemoryBuffer): CacheObject {
+        return CacheObject(
+            s = String(onHeapMemoryBuffer.toTrimmedArray()),
+        )
+    }
+
+    override fun serializeToByteArray(value: CacheObject): ByteArray {
+        return value.s.toByteArray()
+    }
+
+}
+
 suspend fun main() {
     withContext(Dispatchers.Default) {
         OffHeapDemo().run()

examples/src/main/kotlin/com/target/nativememoryallocator/examples/OffHeapDemo.kt renamed to examples/map/src/main/kotlin/com/target/nativememoryallocator/examples/map/OffHeapDemo.kt

@@ -1,4 +1,4 @@
-package com.target.nativememoryallocator.examples
+package com.target.nativememoryallocator.examples.map
 
 import kotlinx.coroutines.*
 import mu.KotlinLogging
@@ -9,6 +9,13 @@ private val logger = KotlinLogging.logger {}
 
 /**
  * Demo application that puts 20,000 [CacheObject] instances into a [ConcurrentHashMap].
+ *
+ * Each [CacheObject] instances 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 [OffHeapDemo].
  */
 class OnHeapDemo {
 

examples/src/main/kotlin/com/target/nativememoryallocator/examples/OnHeapDemo.kt renamed to examples/map/src/main/kotlin/com/target/nativememoryallocator/examples/map/OnHeapDemo.kt

@@ -1,7 +1,13 @@
-package com.target.nativememoryallocator.examples
+package com.target.nativememoryallocator.examples.map
 
 private val charset = ('a'..'z') + ('A'..'Z') + ('0'..'9')
 
+/**
+ * Build a random alphanumeric string.
+ *
+ * @param [length] random string length to build.
+ * @return random string
+ */
 fun buildRandomString(length: Int): String {
     val stringBuilder = StringBuilder(length)
     (0 until length).forEach { _ ->

examples/src/main/kotlin/com/target/nativememoryallocator/examples/StringUtils.kt renamed to examples/map/src/main/kotlin/com/target/nativememoryallocator/examples/map/StringUtils.kt

@@ -1,3 +1,3 @@
 rootProject.name = "native_memory_allocator"
 
-include("examples")
+include("examples:map")