Enum Class MetricLimit.Comparison

java.lang.Object

java.lang.Enum<MetricLimit.Comparison>

org.ek9lang.compiler.support.MetricLimit.Comparison

All Implemented Interfaces:

Serializable, Comparable<MetricLimit.Comparison>, Constable

Enclosing interface:

MetricLimit

public static enum MetricLimit.Comparison
extends Enum<MetricLimit.Comparison>

How a measured value is compared against the limit.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GT	Fires when the value is strictly greater than the limit — the limit value is the last legal one.
GTE	Fires when the value is greater than or equal to the limit — the last legal value is limit - 1.

Method Summary

Modifier and Type	Method	Description
String	symbol()	The comparator as it reads in a report (> / >=) — the one place this string is defined, so every consumer renders it identically.
static MetricLimit.Comparison	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetricLimit.Comparison[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GT

public static final MetricLimit.Comparison GT

Fires when the value is strictly greater than the limit — the limit value is the last legal one.

GTE

public static final MetricLimit.Comparison GTE

Fires when the value is greater than or equal to the limit — the last legal value is limit - 1.

Method Details

values

public static MetricLimit.Comparison[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MetricLimit.Comparison valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

symbol

public String symbol()

The comparator as it reads in a report (> / >=) — the one place this string is defined, so every consumer renders it identically.