Module dev.argon.esexpr

Package dev.argon.esexpr

Record Class KeywordMapping<T>

java.lang.Object

java.lang.Record

dev.argon.esexpr.KeywordMapping<T>

Type Parameters:

T - The element type.

Record Components:

map - The underlying map.

public record KeywordMapping<T>(Map<String,T> map)
extends Record

A KeywordMapping is a Map with String keys.

Constructor Summary

Constructors

Constructor	Description
KeywordMapping(Map<String,T> map)	Creates an instance of a KeywordMapping record class.

Method Summary

Modifier and Type	Method	Description
static <T> ESExprCodec<KeywordMapping<T>>	codec(ESExprCodec<T> tCodec)	Get a codec for the keyword mapping.
static <T> DictCodec<KeywordMapping<T>,T>	dictCodec(ESExprCodec<T> tCodec)	Creates a DictCodec for KeywordMapping values.
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.
Map<String,T>	map()	Returns the value of the map record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

KeywordMapping

public KeywordMapping(Map<String,T> map)

Creates an instance of a KeywordMapping record class.

Parameters:

map - the value for the map record component

Method Details

codec

public static <T> ESExprCodec<KeywordMapping<T>> codec(ESExprCodec<T> tCodec)

Get a codec for the keyword mapping.

Type Parameters:

T - The element type.

Parameters:

tCodec - The element codec.

Returns:

The codec.

dictCodec

public static <T> DictCodec<KeywordMapping<T>,T> dictCodec(ESExprCodec<T> tCodec)

Creates a DictCodec for KeywordMapping values.

Type Parameters:

T - The element type.

Parameters:

tCodec - A value codec for the element type.

Returns:

The DictCodec.

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.

map

public Map<String,T> map()

Returns the value of the map record component.

Returns:

the value of the map record component