Add Describable interface

Signed-off-by: David Greven <[email protected]>

common-types/src/main/java/io/carbynestack/common/CsFailureReason.java

@@ -15,14 +15,15 @@
  * @see Failure
  * @since 0.1.0
  */
-public interface CsFailureReason {
+public interface CsFailureReason extends Describable {
     /**
      * A short summary of the failure reason description.
      *
      * @return the description synopsis
      * @see #description()
      * @since 0.1.0
      */
+    @Override
     String synopsis();
 
     /**
@@ -32,6 +33,7 @@ public interface CsFailureReason {
      * @see #synopsis()
      * @since 0.1.0
      */
+    @Override
     String description();
 
     /**

common-types/src/main/java/io/carbynestack/common/Describable.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2021 - for information on the respective copyright owner
+ * see the NOTICE file and/or the repository https://github.com/carbynestack/common.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package io.carbynestack.common;
+
+/**
+ * Implementations of this interface represent describable
+ * objects that contain a description and synopsis.
+ *
+ * @since 0.1.0
+ */
+public interface Describable {
+    /**
+     * A short summary of the description.
+     *
+     * @return the description synopsis
+     * @see #description()
+     * @since 0.1.0
+     */
+    String synopsis();
+
+    /**
+     * The description.
+     *
+     * @return the full description
+     * @see #synopsis()
+     * @since 0.1.0
+     */
+    String description();
+}