Add shadowJar plugin to examples.

Author: aaronriekenberg

examples/map/README.md

@@ -1,24 +1,34 @@
 # map examples
 
-## onheap
+## running examples
+
+All examples have the gradle `shadowJar` plugin configured to easily run as a standalone app:
+
+```
+cd examples/map/offheap
+java -jar build/libs/*shadowjar*.jar
+```
+
+## onheap example
 
 * 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 is a total of 10GB 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.
+* As this application uses > 10GB of Java heap space, you may have to increase the Java heap size (e.g. `-Xmx20g`).
 
-## offheap
+## offheap example
 
 * 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.
+* Total of 10GB of data in off-heap memory.
 
-## offheap-eviction
+## offheap-eviction example
 
 * 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.
+* Expect 10,000 map entries at end of run with 10,000 total evictions.
 
-## offheap-eviction-operationcounters
+## offheap-eviction-operationcounters example
 
 * Same as offheap-eviction but enables operation counters and logs them at the end of the demo.

examples/map/offheap-eviction-operationcounters/build.gradle.kts

@@ -1,5 +1,8 @@
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+
 plugins {
     kotlin("jvm")
+    id("com.github.johnrengelman.shadow") version "7.1.2"
 }
 
 repositories {
@@ -8,4 +11,19 @@ repositories {
 
 dependencies {
     implementation(project(":examples:map:utils"))
+}
+
+tasks {
+    named<ShadowJar>("shadowJar") {
+        archiveBaseName.set("offheap-eviction-operationcounters-shadowjar")
+        manifest {
+            attributes(mapOf("Main-Class" to "com.target.nativememoryallocator.examples.map.offheap.eviction.operationcounters.OffHeapEvictionOperationCountersKt"))
+        }
+    }
+}
+
+tasks {
+    build {
+        dependsOn(shadowJar)
+    }
 }

examples/map/offheap-eviction/build.gradle.kts

@@ -1,5 +1,8 @@
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+
 plugins {
     kotlin("jvm")
+    id("com.github.johnrengelman.shadow") version "7.1.2"
 }
 
 repositories {
@@ -8,4 +11,19 @@ repositories {
 
 dependencies {
     implementation(project(":examples:map:utils"))
+}
+
+tasks {
+    named<ShadowJar>("shadowJar") {
+        archiveBaseName.set("offheap-eviction-shadowjar")
+        manifest {
+            attributes(mapOf("Main-Class" to "com.target.nativememoryallocator.examples.map.offheap.eviction.OffHeapEvictionKt"))
+        }
+    }
+}
+
+tasks {
+    build {
+        dependsOn(shadowJar)
+    }
 }

examples/map/offheap/build.gradle.kts

@@ -1,5 +1,8 @@
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+
 plugins {
     kotlin("jvm")
+    id("com.github.johnrengelman.shadow") version "7.1.2"
 }
 
 repositories {
@@ -8,4 +11,19 @@ repositories {
 
 dependencies {
     implementation(project(":examples:map:utils"))
+}
+
+tasks {
+    named<ShadowJar>("shadowJar") {
+        archiveBaseName.set("offheap-shadowjar")
+        manifest {
+            attributes(mapOf("Main-Class" to "com.target.nativememoryallocator.examples.map.offheap.OffHeapKt"))
+        }
+    }
+}
+
+tasks {
+    build {
+        dependsOn(shadowJar)
+    }
 }

examples/map/onheap/build.gradle.kts

@@ -1,5 +1,8 @@
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+
 plugins {
     kotlin("jvm")
+    id("com.github.johnrengelman.shadow") version "7.1.2"
 }
 
 repositories {
@@ -8,4 +11,19 @@ repositories {
 
 dependencies {
     implementation(project(":examples:map:utils"))
+}
+
+tasks {
+    named<ShadowJar>("shadowJar") {
+        archiveBaseName.set("onheap-shadowjar")
+        manifest {
+            attributes(mapOf("Main-Class" to "com.target.nativememoryallocator.examples.map.onheap.OnHeapKt"))
+        }
+    }
+}
+
+tasks {
+    build {
+        dependsOn(shadowJar)
+    }
 }