com.google.test.metric.MethodCost Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of testability-explorer Show documentation
A tool that looks at java bytecodes and helps you identify hard to test code.
The newest version!
/*
 * Copyright 2007 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.test.metric;

import com.google.test.metric.report.RemovePackageFormatter;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

public class MethodCost {

  private final String className;
  private final String methodName;
  private final int lineNumber;
  private final boolean constructor;
  private final boolean aStatic;
  private final boolean staticInit;

  private final List costSources = new ArrayList();

  public boolean isConstructor() {
    return constructor;
  }

  public boolean isStatic() {
    return aStatic;
  }

  public Cost getDirectCost() {
    return directCost;
  }

  public Cost getDependentCost() {
    return dependentCost;
  }

  public Cost getConstructorDependentCost() {
    return constructorDependentCost;
  }

  private final Cost directCost = new Cost();
  private final Cost dependentCost = new Cost();
  private final Cost constructorDependentCost = new Cost();

  public static final String METHOD_NAME_ATTRIBUTE = "name";

  /**
   * @param className
   * @param methodName
   *          name of the method, such as {@code void myMethod()}.
   * @param lineNumber
   * @param isStaticInit
   */
  public MethodCost(String className, String methodName, int lineNumber, boolean isConstructor,
                    boolean isStatic,
                    boolean isStaticInit) {
    this.className = className;
    this.methodName = methodName;
    this.lineNumber = lineNumber;
    constructor = isConstructor;
    aStatic = isStatic;
    staticInit = isStaticInit;
  }

  public Cost getTotalCost() {
    return new Cost().add(directCost).add(dependentCost).add(constructorDependentCost);
  }

  public Cost getNonConstructorCost() {
    return new Cost().add(directCost).add(dependentCost);
  }

  public String getMethodName() {
    return methodName;
  }

  public void addCostSource(ViolationCost costSource) {
    costSource.link(directCost, dependentCost, constructorDependentCost);
    costSources.add(costSource);
  }

  @Override
  public String toString() {
    return getMethodName() + toCostsString();
  }

  public String toCostsString() {
    return " [" + getTotalCost() + " / " + directCost + "]";
  }

  public int getMethodLineNumber() {
    return lineNumber;
  }

  public String getClassName() {
    return className;
  }

  public List getViolationCosts() {
    return costSources;
  }

  public List getImplicitViolationCosts() {
    return filterViolationCosts(true);
  }

  public List getExplicitViolationCosts() {
    return filterViolationCosts(false);
  }

  private List filterViolationCosts(boolean implicit) {
    List result = new ArrayList();
    for (ViolationCost cost : getViolationCosts()) {
      if (cost.isImplicit() == implicit) {
        result.add(cost);
      }
    }
    return result;
  }

  public Cost getCost() {
    return directCost;
  }

  public Map getAttributes() {
    Map map = getTotalCost().getAttributes();
    map.put("line", lineNumber);
    map.put(METHOD_NAME_ATTRIBUTE, methodName);
    return map;
  }

  public void link() {
  }

  public boolean isMainMethod() {
    return isStatic() && "void main(java.lang.String[])".equals(getMethodName());
  }

  public String getDescription() {
    return new RemovePackageFormatter().format(methodName);
  }

  public boolean isStaticInit() {
    return staticInit;
  }
}