refact: exclude display methods from jacoco coverage reports (#1188)

equinor · Nov 22, 2024 · d3bdf14 · d3bdf14
1 parent d2eece0
commit d3bdf14
Show file tree

Hide file tree

Showing 89 changed files with 249 additions and 106 deletions.
diff --git a/src/main/java/neqsim/fluidmechanics/flownode/FlowNode.java b/src/main/java/neqsim/fluidmechanics/flownode/FlowNode.java
@@ -18,6 +18,7 @@
 import neqsim.thermo.ThermodynamicConstantsInterface;
 import neqsim.thermo.system.SystemInterface;
 import neqsim.thermodynamicoperations.ThermodynamicOperations;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 import neqsim.util.util.DoubleCloneable;
 
 /**
@@ -574,6 +575,7 @@ public void setEnhancementType(int type) {}
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void display(String name) {
     DecimalFormat nf = new DecimalFormat();
 

diff --git a/...java/neqsim/fluidmechanics/flownode/fluidboundary/heatmasstransfercalc/FluidBoundary.java b/...java/neqsim/fluidmechanics/flownode/fluidboundary/heatmasstransfercalc/FluidBoundary.java
@@ -18,6 +18,7 @@
 import neqsim.fluidmechanics.flownode.fluidboundary.heatmasstransfercalc.nonequilibriumfluidboundary.filmmodelboundary.reactivefilmmodel.enhancementfactor.EnhancementFactor;
 import neqsim.thermo.system.SystemInterface;
 import neqsim.thermodynamicoperations.ThermodynamicOperations;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -478,6 +479,7 @@ public String[][] createTable(String name) {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void display(String name) {
     DecimalFormat nf = new DecimalFormat();
     nf.setMaximumFractionDigits(5);

diff --git a/...ics/util/fluidmechanicsvisualization/flowsystemvisualization/FlowSystemVisualization.java b/...ics/util/fluidmechanicsvisualization/flowsystemvisualization/FlowSystemVisualization.java
@@ -3,6 +3,7 @@
 import neqsim.fluidmechanics.flowsystem.FlowSystemInterface;
 import neqsim.fluidmechanics.util.fluidmechanicsvisualization.flownodevisualization.FlowNodeVisualization;
 import neqsim.fluidmechanics.util.fluidmechanicsvisualization.flownodevisualization.FlowNodeVisualizationInterface;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -75,5 +76,6 @@ public void setPoints() {}
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult(String name) {}
 }
diff --git a/...mvisualization/onephaseflowvisualization/pipeflowvisualization/PipeFlowVisualization.java b/...mvisualization/onephaseflowvisualization/pipeflowvisualization/PipeFlowVisualization.java
@@ -6,6 +6,8 @@
 
 package neqsim.fluidmechanics.util.fluidmechanicsvisualization.flowsystemvisualization.onephaseflowvisualization.pipeflowvisualization;
 
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
+
 /**
  * <p>
  * PipeFlowVisualization class.
@@ -120,6 +122,7 @@ public void calcPoints(String name) {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult(String name) {
     double[][] points = new double[1][1];
     setPoints();

diff --git a/...wophaseflowvisualization/twophasepipeflowvisualization/TwoPhasePipeFlowVisualization.java b/...wophaseflowvisualization/twophasepipeflowvisualization/TwoPhasePipeFlowVisualization.java
@@ -2,6 +2,7 @@
 
 import neqsim.fluidmechanics.flowsystem.FlowSystem;
 import neqsim.fluidmechanics.util.fluidmechanicsvisualization.flownodevisualization.twophaseflownodevisualization.TwoPhaseFlowNodeVisualization;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -115,6 +116,7 @@ public void setPoints() {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult(String name) {
     // double[][] points = new double[1][1];
     setPoints();

diff --git a/src/main/java/neqsim/process/equipment/ProcessEquipmentBaseClass.java b/src/main/java/neqsim/process/equipment/ProcessEquipmentBaseClass.java
@@ -17,6 +17,7 @@
 import neqsim.process.mechanicaldesign.MechanicalDesign;
 import neqsim.process.util.report.Report;
 import neqsim.thermo.system.SystemInterface;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -59,6 +60,7 @@ public SystemInterface getThermoSystem() {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult() {}
 
   /**
@@ -102,8 +104,7 @@ public void setController(ControllerDeviceInterface controller) {
    * Setter for the field <code>flowValveController</code>.
    * </p>
    *
-   * @param controller a {@link neqsim.process.controllerdevice.ControllerDeviceInterface}
-   *        object
+   * @param controller a {@link neqsim.process.controllerdevice.ControllerDeviceInterface} object
    */
   public void setFlowValveController(ControllerDeviceInterface controller) {
     this.flowValveController = controller;
@@ -165,8 +166,7 @@ public EnergyStream getEnergyStream() {
    * Setter for the field <code>energyStream</code>.
    * </p>
    *
-   * @param energyStream a {@link neqsim.process.equipment.stream.EnergyStream}
-   *        object
+   * @param energyStream a {@link neqsim.process.equipment.stream.EnergyStream} object
    */
   public void setEnergyStream(EnergyStream energyStream) {
     setEnergyStream(true);

diff --git a/src/main/java/neqsim/process/equipment/absorber/SimpleAbsorber.java b/src/main/java/neqsim/process/equipment/absorber/SimpleAbsorber.java
@@ -6,6 +6,7 @@
 import neqsim.process.equipment.stream.StreamInterface;
 import neqsim.process.mechanicaldesign.absorber.AbsorberMechanicalDesign;
 import neqsim.thermo.system.SystemInterface;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -49,8 +50,7 @@ public SimpleAbsorber(String name) {
    * </p>
    *
    * @param name name of absorber
-   * @param inStream1 a {@link neqsim.process.equipment.stream.StreamInterface}
-   *        object
+   * @param inStream1 a {@link neqsim.process.equipment.stream.StreamInterface} object
    */
   public SimpleAbsorber(String name, StreamInterface inStream1) {
     super(name);
@@ -222,6 +222,7 @@ public void run(UUID id) {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult() {
     outStream[0].displayResult();
     outStream[1].displayResult();

diff --git a/src/main/java/neqsim/process/equipment/absorber/SimpleTEGAbsorber.java b/src/main/java/neqsim/process/equipment/absorber/SimpleTEGAbsorber.java
@@ -16,6 +16,7 @@
 import neqsim.process.equipment.stream.StreamInterface;
 import neqsim.thermo.system.SystemInterface;
 import neqsim.thermodynamicoperations.ThermodynamicOperations;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -427,6 +428,7 @@ public double getGasLoadFactor() {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult() {
     SystemInterface thermoSystem = mixedStream.getThermoSystem();
     DecimalFormat nf = new DecimalFormat();

diff --git a/src/main/java/neqsim/process/equipment/absorber/WaterStripperColumn.java b/src/main/java/neqsim/process/equipment/absorber/WaterStripperColumn.java
@@ -16,6 +16,7 @@
 import neqsim.thermo.phase.PhaseType;
 import neqsim.thermo.system.SystemInterface;
 import neqsim.thermodynamicoperations.ThermodynamicOperations;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -379,6 +380,7 @@ public void run(UUID id) {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult() {
     SystemInterface thermoSystem = mixedStream.getThermoSystem();
     DecimalFormat nf = new DecimalFormat();

diff --git a/src/main/java/neqsim/process/equipment/adsorber/SimpleAdsorber.java b/src/main/java/neqsim/process/equipment/adsorber/SimpleAdsorber.java
@@ -6,6 +6,7 @@
 import neqsim.process.equipment.stream.StreamInterface;
 import neqsim.process.mechanicaldesign.adsorber.AdsorberMechanicalDesign;
 import neqsim.thermo.system.SystemInterface;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -48,8 +49,7 @@ public SimpleAdsorber(String name) {
    * </p>
    *
    * @param name name of the unit operation
-   * @param inStream1 a {@link neqsim.process.equipment.stream.StreamInterface}
-   *        object
+   * @param inStream1 a {@link neqsim.process.equipment.stream.StreamInterface} object
    */
   public SimpleAdsorber(String name, StreamInterface inStream1) {
     this(name);
@@ -187,6 +187,7 @@ public void run(UUID id) {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult() {
     outStream[0].displayResult();
     outStream[1].displayResult();

diff --git a/src/main/java/neqsim/process/equipment/compressor/Compressor.java b/src/main/java/neqsim/process/equipment/compressor/Compressor.java
@@ -21,6 +21,7 @@
 import neqsim.thermo.ThermodynamicConstantsInterface;
 import neqsim.thermo.system.SystemInterface;
 import neqsim.thermodynamicoperations.ThermodynamicOperations;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -744,6 +745,7 @@ public void generateCompressorCurves() {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult() {
     DecimalFormat nf = new DecimalFormat();
     nf.setMaximumFractionDigits(5);

diff --git a/src/main/java/neqsim/process/equipment/distillation/DistillationColumn.java b/src/main/java/neqsim/process/equipment/distillation/DistillationColumn.java
@@ -12,6 +12,7 @@
 import neqsim.process.equipment.stream.StreamInterface;
 import neqsim.thermo.system.SystemInterface;
 import neqsim.thermodynamicoperations.ThermodynamicOperations;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -86,8 +87,7 @@ public DistillationColumn(String name, int numberOfTraysLocal, boolean hasReboil
    * addFeedStream.
    * </p>
    *
-   * @param inputStream a {@link neqsim.process.equipment.stream.StreamInterface}
-   *        object
+   * @param inputStream a {@link neqsim.process.equipment.stream.StreamInterface} object
    * @param feedTrayNumber a int
    */
   public void addFeedStream(StreamInterface inputStream, int feedTrayNumber) {
@@ -143,8 +143,7 @@ public void init() {
     // .setTotalNumberOfMoles(((Mixer) trays.get(numberOfTrays -
     // 1)).getStream(0).getThermoSystem()
     // .getTotalNumberOfMoles() * (1.0));
-    trays.get(0)
-        .addStream(trays.get(feedTrayNumber).getLiquidOutStream().clone());
+    trays.get(0).addStream(trays.get(feedTrayNumber).getLiquidOutStream().clone());
     // ((Mixer)
     // trays.get(0)).getStream(streamNumbReboil).getThermoSystem().setTotalNumberOfMoles(
     // ((Mixer)
@@ -157,8 +156,7 @@ public void init() {
     double feedTrayTemperature = getTray(getFeedTrayNumber()).getTemperature();
 
     if (trays.get(numberOfTrays - 1).getNumberOfInputStreams() > 0) {
-      condenserTemperature =
-          trays.get(numberOfTrays - 1).getThermoSystem().getTemperature();
+      condenserTemperature = trays.get(numberOfTrays - 1).getThermoSystem().getTemperature();
     } else {
       condenserTemperature = feedTrayTemperature - 1.0;
     }
@@ -343,8 +341,7 @@ public void run(UUID id) {
 
         for (int i = feedTrayNumber; i > 1; i--) {
           int replaceStream1 = trays.get(i - 1).getNumberOfInputStreams() - 1;
-          trays.get(i - 1).replaceStream(replaceStream1,
-              trays.get(i).getLiquidOutStream());
+          trays.get(i - 1).replaceStream(replaceStream1, trays.get(i).getLiquidOutStream());
           trays.get(i - 1).setPressure(bottomTrayPressure - (i - 1) * dp);
           trays.get(i - 1).run(id);
         }
@@ -364,13 +361,11 @@ public void run(UUID id) {
 
         for (int i = numberOfTrays - 2; i >= feedTrayNumber; i--) {
           int replaceStream = trays.get(i).getNumberOfInputStreams() - 1;
-          trays.get(i).replaceStream(replaceStream,
-              trays.get(i + 1).getLiquidOutStream());
+          trays.get(i).replaceStream(replaceStream, trays.get(i + 1).getLiquidOutStream());
           trays.get(i).run(id);
         }
         for (int i = 0; i < numberOfTrays; i++) {
-          err += Math.abs(
-              oldtemps[i] - trays.get(i).getThermoSystem().getTemperature());
+          err += Math.abs(oldtemps[i] - trays.get(i).getThermoSystem().getTemperature());
         }
         logger.info("error iter " + err + " iteration " + iter);
         // System.out.println("error iter " + err + " iteration " + iter);
@@ -395,6 +390,7 @@ public void run(UUID id) {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult() {
     distoperations.displayResult();
   }

diff --git a/src/main/java/neqsim/process/equipment/expander/ExpanderOld.java b/src/main/java/neqsim/process/equipment/expander/ExpanderOld.java
@@ -13,6 +13,7 @@
 import neqsim.process.equipment.stream.StreamInterface;
 import neqsim.thermo.system.SystemInterface;
 import neqsim.thermodynamicoperations.ThermodynamicOperations;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -95,6 +96,7 @@ public void run(UUID id) {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult() {
     DecimalFormat nf = new DecimalFormat();
     nf.setMaximumFractionDigits(5);

diff --git a/src/main/java/neqsim/process/equipment/heatexchanger/HeatExchanger.java b/src/main/java/neqsim/process/equipment/heatexchanger/HeatExchanger.java
@@ -15,6 +15,7 @@
 import neqsim.process.util.monitor.HXResponse;
 import neqsim.thermo.system.SystemInterface;
 import neqsim.thermodynamicoperations.ThermodynamicOperations;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -89,8 +90,7 @@ public HeatExchanger(String name, StreamInterface inStream1, StreamInterface inS
    * Add inlet stream.
    * </p>
    *
-   * @param inStream a {@link neqsim.process.equipment.stream.StreamInterface}
-   *        object
+   * @param inStream a {@link neqsim.process.equipment.stream.StreamInterface} object
    */
   public void addInStream(StreamInterface inStream) {
     // todo: this is probably intended to specifically set the second stream. should be deprecated
@@ -104,8 +104,7 @@ public void addInStream(StreamInterface inStream) {
    * </p>
    *
    * @param number a int
-   * @param inStream a {@link neqsim.process.equipment.stream.StreamInterface}
-   *        object
+   * @param inStream a {@link neqsim.process.equipment.stream.StreamInterface} object
    */
   public void setFeedStream(int number, StreamInterface inStream) {
     this.inStream[number] = inStream;
@@ -446,6 +445,7 @@ public double getDuty() {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult() {
     outStream[0].displayResult();
     outStream[1].displayResult();

diff --git a/src/main/java/neqsim/process/equipment/heatexchanger/Heater.java b/src/main/java/neqsim/process/equipment/heatexchanger/Heater.java
@@ -14,6 +14,7 @@
 import neqsim.process.util.monitor.HeaterResponse;
 import neqsim.thermo.system.SystemInterface;
 import neqsim.thermodynamicoperations.ThermodynamicOperations;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -60,8 +61,7 @@ public Heater(String name) {
    * </p>
    *
    * @param name a {@link java.lang.String} object
-   * @param inStream a {@link neqsim.process.equipment.stream.StreamInterface}
-   *        object
+   * @param inStream a {@link neqsim.process.equipment.stream.StreamInterface} object
    */
   public Heater(String name, StreamInterface inStream) {
     super(name);
@@ -214,6 +214,7 @@ public void runTransient(double dt, UUID id) {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult() {
     // System.out.println("heater dH: " + energyInput);
     getOutletStream().displayResult();

diff --git a/src/main/java/neqsim/process/equipment/heatexchanger/NeqHeater.java b/src/main/java/neqsim/process/equipment/heatexchanger/NeqHeater.java
@@ -3,6 +3,7 @@
 import java.util.UUID;
 import neqsim.process.equipment.stream.StreamInterface;
 import neqsim.thermo.system.SystemInterface;
+import neqsim.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * <p>
@@ -68,6 +69,7 @@ public void run(UUID id) {
 
   /** {@inheritDoc} */
   @Override
+  @ExcludeFromJacocoGeneratedReport
   public void displayResult() {
     System.out.println("heater dH: " + dH);
   }