org.subtlelib.poi.api.totals

Enum Formula

java.lang.Object

java.lang.Enum<Formula>

org.subtlelib.poi.api.totals.Formula

All Implemented Interfaces:

Serializable, Comparable<Formula>

public enum Formula
extends Enum<Formula>

Enum string representation must correspond to valid Excel formulae. Created on 28/03/13

Author:

d.serdiuk

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVERAGE
SUM

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUM

public static final Formula SUM

AVERAGE

public static final Formula AVERAGE

Method Detail

values

public static Formula[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Formula c : Formula.values())
    System.out.println(c);

Returns:

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

valueOf

public static Formula valueOf(String name)

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 name

NullPointerException - if the argument is null