Package net.sourceforge.pmd.lang.metrics

Interface MetricOption

public interface MetricOption
Option to pass to a metric. Options modify the behaviour of a metric. You must bundle them into a MetricOptions to pass them all to a metric.

Options must be suitable for use in sets (implement equals/hashcode, or be singletons).

Author:
Clément Fournier
Since:
6.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    name()
    Returns the name of the option constant.
    String
    valueName()
    Returns the name of the option as it should be used in properties.

  • Method Details

    • name

      String name()
      Returns the name of the option constant.
      Returns:
      The name of the option constant.

    • valueName

      String valueName()
      Returns the name of the option as it should be used in properties.
      Returns:
      The name of the option.