org.decimal4j.scale

Class Scales

java.lang.Object

org.decimal4j.scale.Scales

public final class Scales
extends Object

Utility class with static members to access ScaleMetrics instances.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_SCALE The maximum scale that can be passed to getScaleMetrics(int) without causing an exception; the maximum scale is 18.
static int	MIN_SCALE The minimum scale that can be passed to getScaleMetrics(int) without causing an exception; the minimum scale is 0.
static List<ScaleMetrics>	VALUES All scale metric constants in an immutable ordered list: VALUES=[Scale0f.INSTANCE, Scale1f.INSTANCE, ..., Scale18f.INSTANCE]

Method Summary

Modifier and Type	Method and Description
static ScaleMetrics	findByScaleFactor(long scaleFactor) Returns the ScaleMetrics constant that matches the given scaleFactor if any and null otherwise.
static ScaleMetrics	getScaleMetrics(int scale) Returns the ScaleMetrics constant based on a given scale

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALUES

public static final List<ScaleMetrics> VALUES

All scale metric constants in an immutable ordered list:
VALUES=[Scale0f.INSTANCE, Scale1f.INSTANCE, ..., Scale18f.INSTANCE]

MIN_SCALE

public static final int MIN_SCALE

The minimum scale that can be passed to getScaleMetrics(int) without causing an exception; the minimum scale is 0.

See Also:

Constant Field Values

MAX_SCALE

public static final int MAX_SCALE

The maximum scale that can be passed to getScaleMetrics(int) without causing an exception; the maximum scale is 18.

See Also:

Constant Field Values

Method Detail

getScaleMetrics

public static final ScaleMetrics getScaleMetrics(int scale)

Returns the ScaleMetrics constant based on a given scale

Parameters:

scale - the scale value; must be in [0,18] both ends inclusive

Returns:

the scale metrics constant corresponding to scale

Throws:

IllegalArgumentException - if scale is not in [0, 18]

See Also:

MIN_SCALE, MAX_SCALE

findByScaleFactor

public static final ScaleMetrics findByScaleFactor(long scaleFactor)

Returns the ScaleMetrics constant that matches the given scaleFactor if any and null otherwise.

Parameters:

scaleFactor - the scale factor to find

Returns:

the scale metrics constant with ScaleMetrics.getScaleFactor() equal to scaleFactor if it exists and null otherwise

See Also:

ScaleMetrics.getScaleFactor()