Interface AutoEntryDecoder

All Known Implementing Classes:
FactoryAutoEntryDecoder, ProvidesAutoEntryDecoder
@API(status=STABLE, since="3.0") public interface AutoEntryDecoder
A decoder for auto entries. A decoder can either be registered automatically via SPI or manually by registering it into the registry of the target module.
Since:
3.0

  • Method Details

    • id

      @NotNull @NotNull String id()
      Get the unique identifier of this auto entry decoder. A decoder is called based on the id written into the given input data stream (each entry must be prefixed with the decoder id to use).
      Returns:
      the unique identifier of this auto entry decoder.

    • decodeEntry

      @NotNull @NotNull LazyBindingCollection decodeEntry(@NotNull @NotNull DataInput dataInput, @NotNull @NotNull ClassLoader loader) throws IOException
      Decodes an entry based on the given data input. This decoder must make sure to read all the data that was written during serialization so that the cursor position is at the head for the next deserialization step.
      Parameters:
      dataInput - the data input to read the necessary information from to decode the entry.
      loader - the class loader to use when decoding types.
      Returns:
      a collection of entries that were decoded from the given data input.
      Throws:
      IOException - if an I/O error occurs while reading from the given data input.
      IllegalStateException - in case something goes wrong during binding deserialization.