Module is.codion.common.model

Package is.codion.common.model.summary

Enum Class ColumnSummary

java.lang.Object

java.lang.Enum<ColumnSummary>

is.codion.common.model.summary.ColumnSummary

All Implemented Interfaces:

SummaryModel.Summary, Serializable, Comparable<ColumnSummary>, Constable

public enum ColumnSummary
extends Enum<ColumnSummary>
implements SummaryModel.Summary

The summary types available to the default summary model

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AVERAGE	The average of the supplied values
MAXIMUM	The maximum of the supplied values
MINIMUM	The minimum of the supplied values
MINIMUM_MAXIMUM	The minimum and maximum of the supplied values
NONE	No summary
SUM	The sum of the supplied values

Method Summary

Modifier and Type	Method	Description
static ColumnSummary	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ColumnSummary[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface is.codion.common.model.summary.SummaryModel.Summary

summary

Enum Constant Details

NONE

public static final ColumnSummary NONE

No summary

SUM

public static final ColumnSummary SUM

The sum of the supplied values

AVERAGE

public static final ColumnSummary AVERAGE

The average of the supplied values

MINIMUM

public static final ColumnSummary MINIMUM

The minimum of the supplied values

MAXIMUM

public static final ColumnSummary MAXIMUM

The maximum of the supplied values

MINIMUM_MAXIMUM

public static final ColumnSummary MINIMUM_MAXIMUM

The minimum and maximum of the supplied values

Method Details

values

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