Package io.keikai.axyra.sheets.io

Enum Class FormulaPolicy

java.lang.Object

java.lang.Enum<FormulaPolicy>

io.keikai.axyra.sheets.io.FormulaPolicy

All Implemented Interfaces:

Serializable, Comparable<FormulaPolicy>, Constable

public enum FormulaPolicy
extends Enum<FormulaPolicy>

How formula cells are written by Workbook.save(path, SaveOptions). Only XLSX output applies it; see SaveOptions. The workbook in memory keeps its formulas whatever the policy.

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
BLANK	Writes the cell blank: the formula and its value are both left out.
KEEP	Writes the formula and its cached value; the default.
VALUES_ONLY	Writes the cached value only and leaves out the formula, like Excel's Paste Special > Values.

Method Summary

Modifier and Type	Method	Description
int	code()	The engine code: 0 keep, 1 blank, 2 values only.
static FormulaPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FormulaPolicy[]	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

Enum Constant Details

KEEP

public static final FormulaPolicy KEEP

Writes the formula and its cached value; the default.

BLANK

public static final FormulaPolicy BLANK

Writes the cell blank: the formula and its value are both left out.

VALUES_ONLY

public static final FormulaPolicy VALUES_ONLY

Writes the cached value only and leaves out the formula, like Excel's Paste Special > Values.

Method Details

values

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

code

public int code()

The engine code: 0 keep, 1 blank, 2 values only.