net.openhft.chronicle.wire

Interface WireKey

All Known Subinterfaces:

ParameterizeWireKey

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 interface can be used to encode or decode structured data, and it provides methods for getting the name and the default value of the key, as well as utility methods for working with the key's code.

Method Summary

Modifier and Type	Method and Description
static boolean	checkKeys(@NotNull WireKey[] keys) Checks if the provided array of WireKey objects have unique codes.
default int	code() Calculates the code of the WireKey based on its name.
default boolean	contentEquals(@NotNull CharSequence c) Checks if the provided CharSequence content matches the string representation of this WireKey.
default @Nullable Object	defaultValue() Retrieves the default value associated with this WireKey.
@NotNull CharSequence	name() Retrieves the name of the WireKey.
static int	toCode(@NotNull CharSequence cs) Converts the provided CharSequence into a code.
default Type	type() Determines the type of the WireKey based on its default value.

Method Detail

checkKeys

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

Checks if the provided array of WireKey objects have unique codes. Throws an AssertionError if two or more keys have the same code.

Parameters:

keys - An array of WireKey objects to check.

Returns:

Returns true if all keys have unique codes.

Throws:

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

toCode

static int toCode(@NotNull
                  @NotNull CharSequence cs)

Converts the provided CharSequence into a code. If the CharSequence starts with a digit, it attempts to parse it as an integer. Otherwise, it returns the hash code of the CharSequence.

Parameters:

cs - CharSequence to convert.

Returns:

The converted code.

name

@NotNull
@NotNull CharSequence name()

Retrieves the name of the WireKey.

Returns:

Name of the WireKey.

code

default int code()

Calculates the code of the WireKey based on its name. By default, it uses the toCode(CharSequence) method.

Returns:

Code of the WireKey.

type

default Type type()

Determines the type of the WireKey based on its default value. If the default value is null, it returns Void.class.

Returns:

Type of the WireKey.

defaultValue

@Nullable
default @Nullable Object defaultValue()

Retrieves the default value associated with this WireKey.

Returns:

Default value of the WireKey, or null if not defined.

contentEquals

default boolean contentEquals(@NotNull
                              @NotNull CharSequence c)

Checks if the provided CharSequence content matches the string representation of this WireKey.

Parameters:

c - CharSequence to compare with.

Returns:

True if content matches, otherwise false.