Package net.sourceforge.pmd.lang.metrics

Class ParameterizedMetricKey<N extends Node>

java.lang.Object

net.sourceforge.pmd.lang.metrics.ParameterizedMetricKey<N>

Type Parameters:

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

public final class ParameterizedMetricKey<N extends Node>
extends Object

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	The metric key.
MetricOptions	options	The options of the metric.

Method Summary

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

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

The metric key.

options

public final MetricOptions options

The options of the metric.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getInstance

public static <N extends Node> ParameterizedMetricKey<N> getInstance(MetricKey<N> key,
                                                                     MetricOptions options)

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