[CORDA-2224]: Removed field value from Validated. Renamed function orThrow() to value(). (#4231)

common/configuration-parsing/src/main/kotlin/net/corda/common/configuration/parsing/internal/Properties.kt

@@ -117,7 +117,7 @@ private class OptionalPropertyWithDefault<TYPE : Any>(delegate: Configuration.Pr
 
 private class FunctionalProperty<TYPE, MAPPED : Any>(delegate: Configuration.Property.Definition.Standard<TYPE>, private val mappedTypeName: String, internal val extractListValue: (Config, String) -> List<TYPE>, private val convert: (TYPE) -> Valid<MAPPED>) : RequiredDelegatedProperty<MAPPED, Configuration.Property.Definition.Standard<TYPE>>(delegate), Configuration.Property.Definition.Standard<MAPPED> {
 
-    override fun valueIn(configuration: Config) = convert.invoke(delegate.valueIn(configuration)).orThrow()
+    override fun valueIn(configuration: Config) = convert.invoke(delegate.valueIn(configuration)).value()
 
     override val typeName: String = if (super.typeName == "#$mappedTypeName") super.typeName else "$mappedTypeName(${super.typeName})"
 

common/configuration-parsing/src/test/kotlin/net/corda/common/configuration/parsing/internal/SpecificationTest.kt

@@ -39,7 +39,7 @@ class SpecificationTest {
         val rpcSettings = RpcSettingsSpec.parse(configuration)
 
         assertThat(rpcSettings.isValid).isTrue()
-        assertThat(rpcSettings.orThrow()).satisfies { value ->
+        assertThat(rpcSettings.value()).satisfies { value ->
 
             assertThat(value.useSsl).isEqualTo(useSslValue)
             assertThat(value.addresses).satisfies { addresses ->

common/configuration-parsing/src/test/kotlin/net/corda/common/configuration/parsing/internal/versioned/VersionExtractorTest.kt

@@ -18,7 +18,7 @@ class VersionExtractorTest {
         val versionValue = Configuration.Version.Extractor.DEFAULT_VERSION_VALUE + 1
         val rawConfiguration = configObject("configuration" to configObject("metadata" to configObject("version" to versionValue), "node" to configObject("p2pAddress" to "localhost:8080"))).toConfig()
 
-        val version = extractVersion.invoke(rawConfiguration).orThrow()
+        val version = extractVersion.invoke(rawConfiguration).value()
         assertThat(version).isEqualTo(versionValue)
     }
 
@@ -27,7 +27,7 @@ class VersionExtractorTest {
 
         val rawConfiguration = configObject("configuration" to configObject("node" to configObject("p2pAddress" to "localhost:8080"))).toConfig()
 
-        val version = extractVersion.invoke(rawConfiguration).orThrow()
+        val version = extractVersion.invoke(rawConfiguration).value()
         assertThat(version).isEqualTo(Configuration.Version.Extractor.DEFAULT_VERSION_VALUE)
     }
 
@@ -36,7 +36,7 @@ class VersionExtractorTest {
 
         val rawConfiguration = configObject("configuration" to configObject("metadata" to configObject(), "node" to configObject("p2pAddress" to "localhost:8080"))).toConfig()
 
-        val version = extractVersion.invoke(rawConfiguration).orThrow()
+        val version = extractVersion.invoke(rawConfiguration).value()
 
         assertThat(version).isEqualTo(Configuration.Version.Extractor.DEFAULT_VERSION_VALUE)
     }
@@ -46,7 +46,7 @@ class VersionExtractorTest {
 
         val rawConfiguration = configObject("configuration" to configObject("metadata" to configObject("version" to null), "node" to configObject("p2pAddress" to "localhost:8080"))).toConfig()
 
-        val version = extractVersion.invoke(rawConfiguration).orThrow()
+        val version = extractVersion.invoke(rawConfiguration).value()
 
         assertThat(version).isEqualTo(Configuration.Version.Extractor.DEFAULT_VERSION_VALUE)
     }
@@ -56,7 +56,7 @@ class VersionExtractorTest {
 
         val rawConfiguration = configObject().toConfig()
 
-        val version = extractVersion.invoke(rawConfiguration).orThrow()
+        val version = extractVersion.invoke(rawConfiguration).value()
 
         assertThat(version).isEqualTo(Configuration.Version.Extractor.DEFAULT_VERSION_VALUE)
     }

common/configuration-parsing/src/test/kotlin/net/corda/common/configuration/parsing/internal/versioned/VersionedParsingExampleTest.kt

@@ -52,7 +52,7 @@ class VersionedParsingExampleTest {
     private fun assertResult(result: Valid<RpcSettings>, principalAddressValue: Address, adminAddressValue: Address) {
 
         assertThat(result.isValid).isTrue()
-        assertThat(result.orThrow()).satisfies { value ->
+        assertThat(result.value()).satisfies { value ->
 
             assertThat(value.principal).isEqualTo(principalAddressValue)
             assertThat(value.admin).isEqualTo(adminAddressValue)
@@ -94,7 +94,7 @@ class VersionedParsingExampleTest {
                 val adminAddress = addressFor(adminHost, adminPort)
 
                 return if (principalAddress.isValid && adminAddress.isValid) {
-                    return valid(RpcSettings(principalAddress.value, adminAddress.value))
+                    return valid(RpcSettings(principalAddress.value(), adminAddress.value()))
                 } else {
                     invalid(principalAddress.errors + adminAddress.errors)
                 }
@@ -128,4 +128,4 @@ class VersionedParsingExampleTest {
     }
 }
 
-private fun Configuration.Version.Extractor.parseRequired(config: Config, options: Configuration.Validation.Options = Configuration.Validation.Options.defaults) = parse(config, options).map { it ?: throw IllegalStateException("Absent version value.") }
+private fun Configuration.Version.Extractor.parseRequired(config: Config, options: Configuration.Validation.Options = Configuration.Validation.Options.defaults) = parse(config, options).map { it }

common/validation/src/main/kotlin/net/corda/common/validation/internal/Validated.kt

@@ -8,11 +8,11 @@ import java.util.Collections.emptySet
  */
 interface Validated<TARGET, ERROR> {
     /**
-     * The valid [TARGET] value.
+     * Returns a valid [TARGET] if no validation errors are present. Otherwise, it throws the exception produced by [exceptionOnErrors], defaulting to [IllegalStateException].
      *
-     * @throws IllegalStateException if accessed in presence of validation errors.
+     * @throws IllegalStateException or the result of [exceptionOnErrors] if there are errors.
      */
-    val value: TARGET
+    fun value(exceptionOnErrors: (Set<ERROR>) -> Exception = { errors -> IllegalStateException(errors.joinToString(System.lineSeparator())) }): TARGET
 
     /**
      * The errors produced during validation, if any.
@@ -32,14 +32,7 @@ interface Validated<TARGET, ERROR> {
     /**
      * Returns the underlying value as optional, with a null result instead of an exception if validation rules were violated.
      */
-    val optional: TARGET? get() = if (isValid) value else null
+    val optional: TARGET? get() = if (isValid) value() else null
-
-    /**
-     * Returns a valid [TARGET] if no validation errors are present. Otherwise, it throws the exception produced by [exceptionOnErrors], defaulting to [IllegalStateException].
-     *
-     * @throws IllegalStateException or the result of [exceptionOnErrors] if there are errors.
-     */
-    fun orThrow(exceptionOnErrors: (Set<ERROR>) -> Exception = { errors -> IllegalStateException(errors.joinToString(System.lineSeparator())) }): TARGET
 
     /**
      * Applies the [convert] function to the [TARGET] value, if valid. Otherwise, returns a [Validated] monad with a [MAPPED] generic type and the current errors set.
@@ -62,7 +55,7 @@ interface Validated<TARGET, ERROR> {
      */
     fun doIfValid(action: (TARGET) -> Unit): Validated<TARGET, ERROR> {
         if (isValid) {
-            action.invoke(value)
+            action.invoke(value())
         }
         return this
     }
@@ -110,10 +103,10 @@ interface Validated<TARGET, ERROR> {
         /**
          * A successful validation result, containing a valid [TARGET] value and no [ERROR]s.
          */
-        class Successful<TARGET, ERROR>(override val value: TARGET) : Result<TARGET, ERROR>(), Validated<TARGET, ERROR> {
+        class Successful<TARGET, ERROR>(private val value: TARGET) : Result<TARGET, ERROR>(), Validated<TARGET, ERROR> {
             override val errors: Set<ERROR> = emptySet<ERROR>()
 
-            override fun orThrow(exceptionOnErrors: (Set<ERROR>) -> Exception) = value
+            override fun value(exceptionOnErrors: (Set<ERROR>) -> Exception) = value
 
             override fun <MAPPED> map(convert: (TARGET) -> MAPPED): Validated<MAPPED, ERROR> {
                 return valid(convert.invoke(value))
@@ -136,9 +129,7 @@ interface Validated<TARGET, ERROR> {
                 require(errors.isNotEmpty())
             }
 
-            override val value: TARGET get() = throw IllegalStateException("Invalid state.")
+            override fun value(exceptionOnErrors: (Set<ERROR>) -> Exception) = throw exceptionOnErrors.invoke(errors)
-
-            override fun orThrow(exceptionOnErrors: (Set<ERROR>) -> Exception) = throw exceptionOnErrors.invoke(errors)
 
             override fun <MAPPED> map(convert: (TARGET) -> MAPPED): Validated<MAPPED, ERROR> {
                 return invalid(errors)

node/src/test/kotlin/net/corda/node/services/config/NodeConfigurationImplTest.kt

@@ -234,7 +234,7 @@ class NodeConfigurationImplTest {
     @Test
     fun `jmxReporterType is null and defaults to Jokolia`() {
         val rawConfig = getConfig("working-config.conf", ConfigFactory.parseMap(mapOf("devMode" to true)))
-        val nodeConfig = rawConfig.parseAsNodeConfiguration().orThrow()
+        val nodeConfig = rawConfig.parseAsNodeConfiguration().value()
         assertTrue(JmxReporterType.JOLOKIA.toString() == nodeConfig.jmxReporterType.toString())
     }
 
@@ -242,7 +242,7 @@ class NodeConfigurationImplTest {
     fun `jmxReporterType is not null and is set to New Relic`() {
         var rawConfig = getConfig("working-config.conf", ConfigFactory.parseMap(mapOf("devMode" to true)))
         rawConfig = rawConfig.withValue("jmxReporterType", ConfigValueFactory.fromAnyRef("NEW_RELIC"))
-        val nodeConfig = rawConfig.parseAsNodeConfiguration().orThrow()
+        val nodeConfig = rawConfig.parseAsNodeConfiguration().value()
         assertTrue(JmxReporterType.NEW_RELIC.toString() == nodeConfig.jmxReporterType.toString())
     }
 
@@ -250,7 +250,7 @@ class NodeConfigurationImplTest {
     fun `jmxReporterType is not null and set to Jokolia`() {
         var rawConfig = getConfig("working-config.conf", ConfigFactory.parseMap(mapOf("devMode" to true)))
         rawConfig = rawConfig.withValue("jmxReporterType", ConfigValueFactory.fromAnyRef("JOLOKIA"))
-        val nodeConfig = rawConfig.parseAsNodeConfiguration().orThrow()
+        val nodeConfig = rawConfig.parseAsNodeConfiguration().value()
         assertTrue(JmxReporterType.JOLOKIA.toString() == nodeConfig.jmxReporterType.toString())
     }
 

testing/node-driver/src/main/kotlin/net/corda/testing/node/internal/DriverDSLImpl.kt

@@ -694,7 +694,7 @@ class DriverDSLImpl(
      * Keeping [Config] around is needed as the user may specify extra config options not specified in [NodeConfiguration].
      */
     private class NodeConfig(val typesafe: Config) {
-        val corda: NodeConfiguration = typesafe.parseAsNodeConfiguration().orThrow()
+        val corda: NodeConfiguration = typesafe.parseAsNodeConfiguration().value()
     }
 
     companion object {

testing/node-driver/src/main/kotlin/net/corda/testing/node/internal/NodeBasedTest.kt

@@ -116,7 +116,7 @@ abstract class NodeBasedTest(private val cordappPackages: List<String> = emptyLi
 
         val specificConfig = config.withValue(NodeConfiguration.cordappDirectoriesKey, ConfigValueFactory.fromIterable(cordappDirectories.toSet()))
 
-        val parsedConfig = specificConfig.parseAsNodeConfiguration().orThrow()
+        val parsedConfig = specificConfig.parseAsNodeConfiguration().value()
 
         defaultNetworkParameters.install(baseDirectory)
         val node = InProcessNode(parsedConfig, MOCK_VERSION_INFO.copy(platformVersion = platformVersion), flowManager = flowManager)

tools/demobench/src/test/kotlin/net/corda/demobench/model/NodeConfigTest.kt

@@ -39,7 +39,7 @@ class NodeConfigTest {
                 .withFallback(ConfigFactory.parseResources("reference.conf"))
                 .withFallback(ConfigFactory.parseMap(mapOf("devMode" to true)))
                 .resolve()
-        val fullConfig = nodeConfig.parseAsNodeConfiguration().orThrow()
+        val fullConfig = nodeConfig.parseAsNodeConfiguration().value()
 
         // No custom configuration is created by default.
         assertFailsWith<ConfigException.Missing> { nodeConfig.getConfig("custom") }

tools/network-bootstrapper/src/main/kotlin/net/corda/bootstrapper/nodes/NodeBuilder.kt

@@ -32,7 +32,7 @@ open class NodeBuilder {
                 .withBaseDirectory(nodeDir)
                 .exec(BuildImageResultCallback()).awaitImageId()
         LOG.info("finished building docker image for: $nodeDir with id: $nodeImageId")
-        val config = nodeConfig.parseAsNodeConfigWithFallback(ConfigFactory.parseFile(copiedNode.configFile)).orThrow()
+        val config = nodeConfig.parseAsNodeConfigWithFallback(ConfigFactory.parseFile(copiedNode.configFile)).value()
         return copiedNode.builtNode(config, nodeImageId)
     }