ParameterizedMetricKey (PMD Core 6.26.0 API)

java.lang.Object
- net.sourceforge.pmd.lang.metrics.ParameterizedMetricKey<N>

Type Parameters:

N - Type of node on which the memoized metric can be computed

All Implemented Interfaces:

DataMap.DataKey<ParameterizedMetricKey<N>,Double>
```
@InternalApi
@Deprecated
public final class ParameterizedMetricKey<N extends Node>
extends Object
implements DataMap.DataKey<ParameterizedMetricKey<N>,Double>
```
Deprecated.
Is internal API

Represents a key parameterized with its options. Used to index memoization maps.

Since:

5.8.0

Author:

Clément Fournier

Field Summary

Fields
Modifier and Type Field Description

MetricKey<N> key
Deprecated.

The metric key.

MetricOptions options
Deprecated.

The options of the metric.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`	Deprecated.
`static <N extends Node> ParameterizedMetricKey<N>`	`getInstance(MetricKey<N> key, MetricOptions options)`	Deprecated. Builds a parameterized metric key.
`int`	`hashCode()`	Deprecated.
`String`	`toString()`	Deprecated.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - key
```
public final MetricKey<N extends Node> key
```
    Deprecated.
    
    The metric key.
  - options
```
public final MetricOptions options
```
    Deprecated.
    
    The options of the metric.
- Method Detail
  - toString
```
public String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Deprecated.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Overrides:
    
    hashCode in class Object
  - getInstance
```
public static <N extends Node> ParameterizedMetricKey<N> getInstance(MetricKey<N> key,
                                                                     MetricOptions options)
```
    Deprecated.
    
    Builds a parameterized metric key.
    
    Type Parameters:
    
    N - The type of node of the metric key
    
    Parameters:
    
    key - The key
    
    options - The options
    
    Returns:
    
    An instance of parameterized metric key corresponding to the parameters