Package io.keikai.axyra.sheets

Record Class CustomProperty

java.lang.Object

java.lang.Record

io.keikai.axyra.sheets.CustomProperty

Record Components:

name - the property name

value - the typed value

public record CustomProperty(String name, CustomProperty.Value value)
extends Record

A custom document property — one entry of the workbook's custom file properties part (docProps/custom.xml, ECMA-376 Part 1 §22.3).

A read view returned by Workbook.customProperties(); write through Workbook.setCustomProperty(...) / Workbook.removeCustomProperty(name). Names are matched exactly (case-sensitive).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CustomProperty.Bool	A boolean value (vt:bool).
static final record	CustomProperty.Date	A date value (vt:filetime).
static final record	CustomProperty.Number	A numeric value.
static final record	CustomProperty.Raw	Fidelity view of a variant type outside the modeled set (for example vt:cy currency): vtType is the original element name and value its text, both preserved verbatim in the file across open and save.
static final record	CustomProperty.Text	A text value (vt:lpwstr).
static interface	CustomProperty.Value	The typed value of a custom document property.

Constructor Summary

Constructors

Constructor	Description
CustomProperty(String name, CustomProperty.Value value)	Creates an instance of a CustomProperty record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
CustomProperty.Value	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

CustomProperty

public CustomProperty(String name,
 CustomProperty.Value value)

Creates an instance of a CustomProperty record class.

Parameters:

name - the value for the name record component

value - the value for the value record component

Method Details

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

value

public CustomProperty.Value value()

Returns the value of the value record component.

Returns:

the value of the value record component