Package io.keikai.axyra.sheets.content

Record Class ConditionalFormat.ValueObject

java.lang.Object

java.lang.Record

io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject

Record Components:

type - "min" / "max" / "num" / "percent" / "percentile" / "formula"

value - the threshold number or formula (null for min/max)

gte - greater-than-or-equal comparison (spec default true)

Enclosing class:

ConditionalFormat

public static record ConditionalFormat.ValueObject(String type, String value, boolean gte)
extends Record

A threshold value object of a color-scale / data-bar / icon-set rule (ECMA-376 §18.3.1.11 cfvo).

Constructor Summary

Constructors

Constructor	Description
ValueObject(String type, String value, boolean gte)	Creates an instance of a ValueObject record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	gte()	Returns the value of the gte record component.
final int	hashCode()	Returns a hash code value for this object.
static ConditionalFormat.ValueObject	of(String type)	A valueless threshold ("min" / "max").
static ConditionalFormat.ValueObject	of(String type, String value)	A threshold with a number or formula value.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.
String	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ValueObject

public ValueObject(String type,
 String value,
 boolean gte)

Creates an instance of a ValueObject record class.

Parameters:

type - the value for the type record component

value - the value for the value record component

gte - the value for the gte record component

Method Details

of

public static ConditionalFormat.ValueObject of(String type)

A valueless threshold ("min" / "max").

of

public static ConditionalFormat.ValueObject of(String type,
 String value)

A threshold with a number or formula value.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

value

public String value()

Returns the value of the value record component.

Returns:

the value of the value record component

gte

public boolean gte()

Returns the value of the gte record component.

Returns:

the value of the gte record component