Add Configurable to common/capabilities 67/100967/1
authorJim Hahn <jrh3@att.com>
Fri, 31 Jan 2020 00:15:01 +0000 (19:15 -0500)
committerJim Hahn <jrh3@att.com>
Fri, 31 Jan 2020 00:15:01 +0000 (19:15 -0500)
Issue-ID: POLICY-1625
Signed-off-by: Jim Hahn <jrh3@att.com>
Change-Id: Iab0ce1ba0c478d646546d02734228ef97d58b4c4

capabilities/src/main/java/org/onap/policy/common/capabilities/Configurable.java [new file with mode: 0644]

diff --git a/capabilities/src/main/java/org/onap/policy/common/capabilities/Configurable.java b/capabilities/src/main/java/org/onap/policy/common/capabilities/Configurable.java
new file mode 100644 (file)
index 0000000..9728674
--- /dev/null
@@ -0,0 +1,43 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.common.capabilities;
+
+/**
+ * Object that can be configured.
+ *
+ * @param <T> type of parameters
+ */
+public interface Configurable<T> {
+
+    /**
+     * Determines if this object has been configured.
+     *
+     * @return {@code true} if this object has been configured, {@code false} otherwise
+     */
+    boolean isConfigured();
+
+    /**
+     * Configures this object.
+     *
+     * @param parameters configuration parameters
+     */
+    void configure(T parameters);
+}