Enum Cumulation
- All Implemented Interfaces:
Serializable
,Comparable<Cumulation>
,java.lang.constant.Constable
Cumulative mode for histogram-like plots.
- Since:
- 10 Mar 2021
- Author:
- Mark Taylor
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionReturns a plain-text description of the meaning of this mode.boolean
Indicates whether this mode is cumulative.boolean
Indicates whether any cumulativeness is in the positive coordinate direction.static Cumulation
Returns the enum constant of this type with the specified name.static Cumulation[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
NONE
Not cumulative. -
FORWARD
Cumulative in increasing coordinate direction. -
REVERSE
Cumulative in decreasing coordinate direction.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
isCumulative
public boolean isCumulative()Indicates whether this mode is cumulative.- Returns:
- true for cumulative, false for normal
-
isReverse
public boolean isReverse()Indicates whether any cumulativeness is in the positive coordinate direction.- Returns:
- false for positive direction, true for negative direction
-
getTextDescription
Returns a plain-text description of the meaning of this mode.- Returns:
- plain-text description
-