Package net.pricefx.common.api.chart

Enum Class LimitPosition

Object

Enum<LimitPosition>

LimitPosition

All Implemented Interfaces:

Serializable, Comparable<LimitPosition>, Constable

public enum LimitPosition
extends Enum<LimitPosition>

Chooses which end of a series' ranked rows a Top-N/Bottom-N limit keeps, set with a concrete series type's setLimitTo(LimitPosition, java.math.BigDecimal, LimitType) method, for example PieChart.PieSeries.setLimitTo(LimitPosition, java.math.BigDecimal, LimitType).

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM	Keeps the lowest-ranked rows, for example the bottom 10 customers by revenue.
TOP	Keeps the highest-ranked rows, for example the top 10 customers by revenue.

Method Summary

Modifier and Type	Method	Description
static LimitPosition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LimitPosition[]	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

TOP

public static final LimitPosition TOP

Keeps the highest-ranked rows, for example the top 10 customers by revenue.

BOTTOM

public static final LimitPosition BOTTOM

Keeps the lowest-ranked rows, for example the bottom 10 customers by revenue.

Method Details

values

public static LimitPosition[] 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 LimitPosition 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