Record Class KeyDescriptor

java.lang.Object
java.lang.Record
io.micronaut.serde.KeyDescriptor
Record Components:
name - The serialized key name
metadata - Backend-neutral serde configuration keyed by its internal member name
@Internal public record KeyDescriptor(String name, Map<String,String> metadata) extends Record
Describes an object key and immutable configuration that key providers can precompute for their backend.
Since:
3.2
Author:
Denis Stepanov

  • Constructor Details

    • KeyDescriptor

      public KeyDescriptor(String name, Map<String,String> metadata)
      Creates an immutable key descriptor.
      Since:
      3.2

    • KeyDescriptor

      public KeyDescriptor(String name)
      Creates a key descriptor without additional metadata.
      Parameters:
      name - The serialized key name
      Since:
      3.2

  • Method Details

    • create

      public static KeyDescriptor create(String name, String... metadata)
      Creates a descriptor from alternating metadata names and values.
      Parameters:
      name - The serialized key name
      metadata - Alternating metadata names and values
      Returns:
      The key descriptor
      Since:
      3.2

    • 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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • metadata

      public Map<String,String> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component