Interface KeysAwareEncoder

All Superinterfaces:

AutoCloseable, Encoder

All Known Implementing Classes:

BsonWriterEncoder, JacksonEncoder

@Internal
public interface KeysAwareEncoder
extends Encoder

Optional encoder capability for writing object keys from a known key set.

Since:

3.1

Author:

Denis Stepanov

Method Summary

Modifier and Type	Method	Description
void	encodeKey(Keys keys, int index)	Encode a key by index from the supplied key set.
static KeysAwareEncoder	of(Encoder encoder)	Adapt the encoder to the keys-aware contract.

Methods inherited from interface Encoder

close, currentPath, encodeArray, encodeBigDecimal, encodeBigInteger, encodeBinary, encodeBoolean, encodeByte, encodeChar, encodeDouble, encodeFloat, encodeInt, encodeKey, encodeLong, encodeNull, encodeObject, encodeShort, encodeString, finishStructure

Method Details

of

static KeysAwareEncoder of(Encoder encoder)

Adapt the encoder to the keys-aware contract.

Parameters:

encoder - The encoder

Returns:

A keys-aware encoder

encodeKey

void encodeKey(Keys keys,
 int index)
        throws IOException

Encode a key by index from the supplied key set.

Parameters:

keys - The keys

index - The key index

Throws:

IOException - If an unrecoverable error occurs