From 4263719b0c4bdb02cfda5a5940c5981c7701581b Mon Sep 17 00:00:00 2001
From: Jim Hahn <jrh3@att.com>
Date: Thu, 11 Apr 2019 16:44:16 -0400
Subject: Add ValidationResult for arbitrary beans

Added implementations of ValidationResult for arbitrary objects and
for beans (i.e., containers of arbitrary objects).

Change-Id: I4c6f35bd19f1386062ce19125cbc648c399cc331
Issue-ID: POLICY-1542
Signed-off-by: Jim Hahn <jrh3@att.com>
---
 .../common/parameters/ValidationResultImpl.java    | 120 +++++++++++++++++++++
 1 file changed, 120 insertions(+)
 create mode 100644 common-parameters/src/main/java/org/onap/policy/common/parameters/ValidationResultImpl.java

(limited to 'common-parameters/src/main/java/org/onap/policy/common/parameters/ValidationResultImpl.java')

diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/ValidationResultImpl.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/ValidationResultImpl.java
new file mode 100644
index 00000000..1d8aa239
--- /dev/null
+++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/ValidationResultImpl.java
@@ -0,0 +1,120 @@
+/*
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.common.parameters;
+
+import lombok.Getter;
+
+/**
+ * Basic implementation of a ValidationResult.
+ */
+@Getter
+public abstract class ValidationResultImpl implements ValidationResult {
+    public static final String ITEM_HAS_STATUS_MESSAGE = "item has status ";
+
+    /**
+     * Name of the object of this result.
+     */
+    private final String name;
+
+    /**
+     * Object being validated.
+     */
+    private final Object object;
+
+    /**
+     * Validation status of this object.
+     */
+    private ValidationStatus status = ValidationStatus.CLEAN;
+
+    /**
+     * Validation message.
+     */
+    private String message = ITEM_HAS_STATUS_MESSAGE + status.toString();
+
+
+    /**
+     * Constructs the object.
+     *
+     * @param name name of the object of this result
+     * @param object object being validated
+     */
+    public ValidationResultImpl(String name, Object object) {
+        this.name = name;
+        this.object = object;
+    }
+
+    /**
+     * Constructs the object.
+     *
+     * @param name name of the object of this result
+     * @param object object being validated
+     * @param status the validation status
+     * @param message the validation message explaining the validation status
+     */
+    public ValidationResultImpl(String name, Object object, ValidationStatus status, String message) {
+        this.name = name;
+        this.object = object;
+        this.status = status;
+        this.message = message;
+    }
+
+    /**
+     * Validates that the value is not {@code null}.
+     *
+     * @return {@code true} if the value is not null, {@code false} otherwise
+     */
+    public boolean validateNotNull() {
+        if (object == null) {
+            setResult(ValidationStatus.INVALID, "is null");
+            return false;
+
+        } else {
+            return true;
+        }
+    }
+
+    /**
+     * Set the validation result status. On a sequence of calls, the most serious
+     * validation status is recorded, assuming the status enum ordinals increase in order
+     * of severity.
+     *
+     * @param status validation status the bean is receiving
+     */
+    public void setResult(final ValidationStatus status) {
+        setResult(status, ITEM_HAS_STATUS_MESSAGE + status.toString());
+    }
+
+    /**
+     * Set the validation result status. On a sequence of calls, the most serious
+     * validation status is recorded, assuming the status enum ordinals increase in order
+     * of severity.
+     *
+     * @param status the validation status
+     * @param message the validation message explaining the validation status
+     */
+    @Override
+    public void setResult(final ValidationStatus status, final String message) {
+        if (this.status.ordinal() < status.ordinal()) {
+            this.status = status;
+            this.message = message;
+        }
+    }
+}
-- 
cgit 1.2.3-korg