Package nl.pim16aap2.lightkeeper.protocol

Interface IProtocolValue

All Known Implementing Classes:
IProtocolValue.PBool, IProtocolValue.PDropped, IProtocolValue.PEnum, IProtocolValue.PList, IProtocolValue.PNumber, IProtocolValue.PRecord, IProtocolValue.PRef, IProtocolValue.PString, IProtocolValue.PUuid, IProtocolValue.PVec
public sealed interface IProtocolValue permits IProtocolValue.PString, IProtocolValue.PNumber, IProtocolValue.PBool, IProtocolValue.PUuid, IProtocolValue.PEnum, IProtocolValue.PVec, IProtocolValue.PList, IProtocolValue.PRecord, IProtocolValue.PRef, IProtocolValue.PDropped
Typed wire envelope for structured payload values.

Every value crossing the agent protocol as part of a structured payload (e.g. captured event fields) is one of these leaves. The envelope replaces flat string-only payloads: consumers receive real types, nesting is explicit (IProtocolValue.PList, IProtocolValue.PRecord), identities travel as references (IProtocolValue.PRef), and values the encoder cannot represent are reported as IProtocolValue.PDropped markers instead of being silently skipped.

Jackson uses the "type" JSON property to select the correct leaf during deserialization; adding a leaf requires a new JsonSubTypes.Type entry and a permits entry here.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final record 
    IProtocolValue.PBool
    A boolean value.
    static final record 
    IProtocolValue.PDropped
    A marker for a value the encoder could not represent — the fail-loud replacement for silently skipping it.
    static final record 
    IProtocolValue.PEnum
    An enum constant.
    static final record 
    IProtocolValue.PList
    An ordered list of values.
    static final record 
    IProtocolValue.PNumber
    A numeric value.
    static final record 
    IProtocolValue.PRecord
    A nested structured value: named fields, insertion-ordered.
    static final record 
    IProtocolValue.PRef
    A reference to an identifiable object (e.g. an entity by UUID or a world by name) rather than its contents.
    static final record 
    IProtocolValue.PString
    A text value.
    static final record 
    IProtocolValue.PUuid
    A UUID value.
    static final record 
    IProtocolValue.PVec
    Double-precision position coordinates.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    toDisplayString()
    Renders this value as human-readable text for assertion messages and diagnostics.

  • Method Details

    • toDisplayString

      String toDisplayString()
      Renders this value as human-readable text for assertion messages and diagnostics.
      Returns:
      The rendered value.