Rename FailedCriterion message field to description

Signed-off-by: lisrte <[email protected]>
powsybl · Dec 12, 2024 · ce808c6 · ce808c6
1 parent 5e80c5f
commit ce808c6
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/dynaflow/src/main/java/com/powsybl/dynaflow/results/FailedCriterion.java b/dynaflow/src/main/java/com/powsybl/dynaflow/results/FailedCriterion.java
@@ -9,9 +9,9 @@
 
 /**
  * scenarioResults or loadIncreaseResults failed criterion
- * @param message Failed criterion message
+ * @param description Failed criterion description
  * @param time Failure time (in seconds)
  * @author Laurent Issertial {@literal <laurent.issertial at rte-france.com>}
  */
-public record FailedCriterion(String message, double time) {
+public record FailedCriterion(String description, double time) {
 }
diff --git a/dynaflow/src/main/java/com/powsybl/dynaflow/results/ResultsUtil.java b/dynaflow/src/main/java/com/powsybl/dynaflow/results/ResultsUtil.java
@@ -57,13 +57,13 @@ static Optional<ScenarioResult> createScenarioResult(String id, String status, L
         return Optional.empty();
     }
 
-    static Optional<FailedCriterion> createFailedCriterion(String message, String time) {
-        if (message == null || time == null) {
-            LOGGER.warn("Inconsistent failed criterion entry (message: '{}', time: '{}')", message, time);
+    static Optional<FailedCriterion> createFailedCriterion(String description, String time) {
+        if (description == null || time == null) {
+            LOGGER.warn("Inconsistent failed criterion entry (description: '{}', time: '{}')", description, time);
         } else {
             try {
                 double timeD = Double.parseDouble(time);
-                return Optional.of(new FailedCriterion(message, timeD));
+                return Optional.of(new FailedCriterion(description, timeD));
             } catch (NumberFormatException e) {
                 logInconsistentEntry("time", time);
             }

diff --git a/dynaflow/src/main/java/com/powsybl/dynaflow/results/XmlScenarioResultParser.java b/dynaflow/src/main/java/com/powsybl/dynaflow/results/XmlScenarioResultParser.java
@@ -49,10 +49,10 @@ public static void readScenarioResult(String elementName, XMLStreamReader xmlRea
     public static void readFailedCriterion(String elementName, XMLStreamReader xmlReader, Consumer<FailedCriterion> resultConsumer) {
         try {
             if (elementName.equals("criterionNonRespected")) {
-                String message = xmlReader.getAttributeValue(null, ID);
+                String description = xmlReader.getAttributeValue(null, ID);
                 String time = xmlReader.getAttributeValue(null, TIME);
                 XmlUtil.readEndElementOrThrow(xmlReader);
-                ResultsUtil.createFailedCriterion(message, time).ifPresent(resultConsumer);
+                ResultsUtil.createFailedCriterion(description, time).ifPresent(resultConsumer);
             }
         } catch (XMLStreamException e) {
             throw new UncheckedXmlStreamException(e);