Package net.sourceforge.pmd.lang.metrics

Class MetricOptions

java.lang.Object

net.sourceforge.pmd.lang.metrics.MetricOptions

public class MetricOptions
extends Object

Bundles a set of options to pass to a metric. Metrics may use these options as they see fit.

Since:

6.0.0

Author:

Clément Fournier

Method Summary

Modifier and Type	Method	Description
boolean	contains(MetricOption option)	Returns true if this bundle contains the given option.
static MetricOptions	emptyOptions()	Returns an empty options bundle.
boolean	equals(Object o)
Set<MetricOption>	getOptions()	Returns an immutable set of options.
int	hashCode()
static MetricOptions	ofOptions(Collection<? extends MetricOption> options)	Gets an options bundle from a collection of options.
static MetricOptions	ofOptions(MetricOption option, MetricOption... options)	Gets an options bundle from options.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getOptions

public Set<MetricOption> getOptions()

Returns an immutable set of options. Metrics may use these options as they see fit.

Returns:

The set of options of this version

contains

public boolean contains(MetricOption option)

Returns true if this bundle contains the given option.

Parameters:

option - Option to look for

toString

public String toString()

Overrides:

toString in class Object

emptyOptions

public static MetricOptions emptyOptions()

Returns an empty options bundle.

Returns:

An empty options bundle

ofOptions

public static MetricOptions ofOptions(Collection<? extends MetricOption> options)

Gets an options bundle from a collection of options.

Parameters:

options - The options to build the bundle from

Returns:

An options bundle

ofOptions

public static MetricOptions ofOptions(MetricOption option,
                                      MetricOption... options)

Gets an options bundle from options.

Parameters:

option - Mandatory first argument

options - Rest of the options

Returns:

An options bundle