Coverage Report - com.sdmetrics.metrics.MetricProcedure - www.sdmetrics.com
 
Classes in this File Line Coverage Branch Coverage Complexity
MetricProcedure
100%
1/1
N/A
1
 
 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;
 23  
 
 24  
 import com.sdmetrics.model.ModelElement;
 25  
 
 26  
 /**
 27  
  * Base class for all metric procedures.
 28  
  */
 29  237
 public abstract class MetricProcedure extends AbstractProcedure {
 30  
 
 31  
         /**
 32  
          * Calculates the metric procedure.
 33  
          * 
 34  
          * @param element The model element for which to calculate the procedure.
 35  
          * @param metric The metric to calculate.
 36  
          * @return Value of the metric. This should be an Integer, a Float, a
 37  
          *         String, or a model element.
 38  
          * @throws SDMetricsException Problem during the calculation of the metric.
 39  
          */
 40  
         protected abstract Object calculate(ModelElement element, Metric metric)
 41  
                         throws SDMetricsException;
 42  
 }