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.
    default String
    valueName()
    Deprecated.
    Since 7.21.0.

  • Method Details

    • name

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

    • valueName

      @Deprecated default String valueName()
      Deprecated.
      Since 7.21.0. When metrics are used for (rule) properties, then the conventional enum mapping (from SCREAMING_SNAKE_CASE to camelCase) will be used for the enum values. See PropertyFactory.conventionalEnumListProperty(String, Class).
      Returns the name of the option as it should be used in properties.
      Returns:
      The name of the option.