Interface KeysProvider

All Known Implementing Classes:

BsonKeysProvider, JacksonKeysProvider, XmlKeysProvider

@Internal
public interface KeysProvider

Service-loaded contributor for backend-specific key data.

Since:

3.1

Author:

Denis Stepanov

Method Summary

Modifier and Type	Method	Description
Object[]	create(List<String> keys)	Create backend-specific data for the supplied keys.
default Object[]	create(List<String> keys, boolean caseInsensitive)	Create backend-specific data for the supplied keys.
default Object[]	createWithMetadata(List<KeyDescriptor> keys, boolean caseInsensitive)	Create backend-specific data for keys with pre-resolved serde configuration.
Class<?>	keysType()	The contribution type supplied by this provider.

Method Details

keysType

Class<?> keysType()

The contribution type supplied by this provider.

Returns:

The contribution type

create

Object[] create(List<String> keys)

Create backend-specific data for the supplied keys. The returned value must be safe to reuse across encoder and decoder instances.

Parameters:

keys - The keys

Returns:

The backend-specific data

create

default Object[] create(List<String> keys,
 boolean caseInsensitive)

Create backend-specific data for the supplied keys. The returned value must be safe to reuse across encoder and decoder instances.

Parameters:

keys - The keys

caseInsensitive - Whether key matching should be case-insensitive

Returns:

The backend-specific data

createWithMetadata

default Object[] createWithMetadata(List<KeyDescriptor> keys,
 boolean caseInsensitive)

Create backend-specific data for keys with pre-resolved serde configuration.

The default implementation preserves compatibility with providers that only need key names.

Parameters:

keys - The key descriptors

caseInsensitive - Whether key matching should be case-insensitive

Returns:

The backend-specific data

Since:

3.2