Test coverage report for RuleViolation.java - www.sdmetrics.com

  1. /*
  2.  * SDMetrics Open Core for UML design measurement
  3.  * Copyright (c) Juergen Wuest
  4.  * To contact the author, see <http://www.sdmetrics.com/Contact.html>.
  5.  * 
  6.  * This file is part of the SDMetrics Open Core.
  7.  * 
  8.  * SDMetrics Open Core is free software: you can redistribute it and/or modify
  9.  * it under the terms of the GNU Affero General Public License as
  10.  * published by the Free Software Foundation, either version 3 of the
  11.  * License, or (at your option) any later version.
  12.     
  13.  * SDMetrics Open Core is distributed in the hope that it will be useful,
  14.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16.  * GNU Affero General Public License for more details.
  17.  *
  18.  * You should have received a copy of the GNU Affero General Public License
  19.  * along with SDMetrics Open Core.  If not, see <http://www.gnu.org/licenses/>.
  20.  *
  21.  */
  22. package com.sdmetrics.metrics;

  24. import com.sdmetrics.model.ModelElement;

  26. /**
  27.  * Stores details about the violation of one specific rule by one specific model
  28.  * element.
  29.  */
  30. public class RuleViolation {
  31.     /** The violating model element. */
  32.     private final ModelElement element;
  33.     /** The violated rule. */
  34.     private final Rule rule;
  35.     /** The value of the rule describing the violation. */
  36.     private final Object value;

  38.     /**
  39.      * Constructor.
  40.      * @param element The violating model element.
  41.      * @param rule The violated rule.
  42.      * @param value Value of the rule violation.
  43.      */
  44.     public RuleViolation(ModelElement element, Rule rule, Object value) {
  45.         this.element = element;
  46.         this.rule = rule;
  47.         this.value = value;
  48.     }

  50.     /**
  51.      * Gets the model element of this rule violation.
  52.      * 
  53.      * @return The violating model element.
  54.      */
  55.     public ModelElement getModelElement() {
  56.         return element;
  57.     }

  59.     /**
  60.      * Gets the rule of this rule violation.
  61.      * 
  62.      * @return The violated rule.
  63.      */
  64.     public Rule getRule() {
  65.         return rule;
  66.     }

  68.     /**
  69.      * Gets the value for this rule violation.
  70.      * 
  71.      * @return Value of the rule describing the violation.
  72.      */
  73.     public Object getValue() {
  74.         return value;
  75.     }

  77. }
Created with JaCoCo 0.8.2.201808211720