net.openhft.chronicle.wire

Interface WireKey

All Known Implementing Classes:

MethodWireKey

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface WireKey

Represents a unique identifier or key for wiring protocols. This is a functional interface where name() is the primary method. Implementations are typically enums or small classes. A WireKey associates a textual name with a numeric code() for use in binary wire formats.

Method Summary

Modifier and Type	Method and Description
static boolean	checkKeys(@NotNull WireKey[] keys) Checks that each entry uses a distinct code() value.
default int	code() Returns a numeric code for this key, typically derived from its name().
default boolean	contentEquals(@NotNull CharSequence c) Compares the string representation of this WireKey (obtained via this.toString()) with the provided CharSequence c for content equality.
default @Nullable Object	defaultValue() Returns the default value for the field or event represented by this key.
@NotNull CharSequence	name() Returns the textual name of this key.
static int	toCode(@NotNull CharSequence cs) Converts a textual name to a numeric code.
default Type	type() Returns the Type associated with the value this key typically represents, inferred from defaultValue().

Method Detail

checkKeys

static boolean checkKeys(@NotNull
                         @NotNull WireKey[] keys)

Checks that each entry uses a distinct code() value.

Parameters:

keys - An array of WireKey objects to be checked for unique code() values.

Returns:

true if all codes are unique.

Throws:

AssertionError - if two or more keys share the same code.

toCode

static int toCode(@NotNull
                  @NotNull CharSequence cs)

Converts a textual name to a numeric code. If the text begins with a digit it is parsed as an integer, otherwise its hash code is used.

Parameters:

cs - The CharSequence (typically a field or event name) to convert into a numeric code.

Returns:

the derived code.

name

@NotNull
@NotNull CharSequence name()

Returns the textual name of this key. This is often used in text-based wire formats or for debugging.

Returns:

the name of this key.

code

default int code()

Returns a numeric code for this key, typically derived from its name(). By default this delegates to toCode(CharSequence).

Returns:

the code for this key.

type

default Type type()

Returns the Type associated with the value this key typically represents, inferred from defaultValue(). Returns Void.class if no default value is defined.

Returns:

the associated type.

defaultValue

@Nullable
default @Nullable Object defaultValue()

Returns the default value for the field or event represented by this key. Deserialisers may use this if the key is absent. null indicates no default.

Returns:

the default value or null.

contentEquals

default boolean contentEquals(@NotNull
                              @NotNull CharSequence c)

Compares the string representation of this WireKey (obtained via this.toString()) with the provided CharSequence c for content equality.

Parameters:

c - The CharSequence to compare against this key's string form.

Returns:

true if the contents are equal.