Added typeReference function.

Author: MrMatthewLayton

CHANGELOG.md

@@ -21,7 +21,7 @@ This document serves as the change log for the ONIXLabs Corda Core API.
 >
 >   🔐 **CORDAPP SIGNING**
 >
->   As of version 1.0.0, this API has been signed with the ONIXLabs production signing key. Historically, clones of this repository would have failed to build, since the signing key is a secret. Version 2.0.0 ships with the ONIXLabs developer key, allowing this repository to be cloned, built and tested locally.
+>   As of version 1.0.0, packaged releases of this API has been signed with the ONIXLabs production signing key. Historically, clones of this repository would have failed to build, since the ONIXLabs production signing key is a secret. Version 2.0.0 ships with the ONIXLabs developer key, allowing this repository to be cloned, built and tested locally.
 
 ---
 
@@ -31,15 +31,29 @@ This document serves as the change log for the ONIXLabs Corda Core API.
 
 **Package:** io.onixlabs.corda.core
 
-Represents a reference to an underlying type.
+Represents a type reference which obtains full generic type information for the underlying generic type.
 
 ```kotlin
 abstract class TypeReference<T> : Comparable<TypeReference<T>>
 ```
 
-#### Remarks
+>   🔵  **INFORMATION**
+>
+>   This implementation is inspired by the `TypeReference<T>` class in [fasterxml, jackson-core](https://fasterxml.github.io/jackson-core/javadoc/2.8/com/fasterxml/jackson/core/type/TypeReference.html).
 
-This generic abstract class is derived from the `TypeReference<T>` class is jackson fasterxml.
+---
+
+### typeReference _Function_
+
+**Module:** onixlabs-corda-core-contract
+
+**Package:** io.onixlabs.corda.core
+
+Creates a type reference of the reified generic type.
+
+```kotlin
+inline fun <reified T> typeReference(): TypeReference<T>
+```
 
 ---
 

build.gradle

@@ -42,7 +42,7 @@ buildscript {
 }
 
 group 'io.onixlabs'
-version '2.0.0-rc1'
+version '2.0.0-rc2'
 
 subprojects {
     repositories {

onixlabs-corda-core-contract/src/main/kotlin/io/onixlabs/corda/core/Extensions.TypeReference.kt

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2020-2021 Matthew Layton
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.onixlabs.corda.core
+
+/**
+ * Creates a type reference of the reified generic type.
+ *
+ * @param T The reified generic type for which to obtain type reference information.
+ * @return Returns a [TypeReference] containing the type information of type [T].
+ */
+inline fun <reified T> typeReference(): TypeReference<T> {
+    return object : TypeReference<T>() {}
+}

onixlabs-corda-core-contract/src/main/kotlin/io/onixlabs/corda/core/TypeReference.kt

@@ -20,12 +20,14 @@ import java.lang.reflect.ParameterizedType
 import java.lang.reflect.Type
 
 /**
- * Represents a reference to an underlying type.
- * This generic abstract class is derived from the TypeReference class is jackson fasterxml.
+ * Represents a type reference which obtains full generic type information for the underlying generic type.
  *
- * @param T The underlying type.
- * @property type The underlying type.
- * @property arguments The generic arguments of the underlying type.
+ * This implementation is inspired by the TypeReference class in fasterxml, jackson-core.
+ * https://fasterxml.github.io/jackson-core/javadoc/2.8/com/fasterxml/jackson/core/type/TypeReference.html
+ *
+ * @param T The underlying type for which to obtain type information.
+ * @property type The actual underlying type.
+ * @property arguments The actual generic argument types of the underlying type.
  */
 abstract class TypeReference<T> : Comparable<TypeReference<T>> {