Package org.wildfly.clustering.marshalling

Interface Externalizer<T>

public interface Externalizer<T>
Service provider interface for custom externalizers.
Author:
Paul Ferraro

  • Method Summary

    Modifier and Type
    Method
    Description
    Class<T>
    getTargetClass()
    Returns the target class of the object to externalize.
    T
    readObject(ObjectInput input)
    Read an instance from the stream.
    default OptionalInt
    size(T object)
    Returns the size of the buffer to use for marshalling the specified object, if known.
    void
    writeObject(ObjectOutput output, T object)
    Writes the object reference to the stream.

  • Method Details

    • writeObject

      void writeObject(ObjectOutput output, T object) throws IOException
      Writes the object reference to the stream.
      Parameters:
      output - the object output to write to
      object - the object reference to write
      Throws:
      IOException - if an I/O error occurs

    • readObject

      T readObject(ObjectInput input) throws IOException, ClassNotFoundException
      Read an instance from the stream. The instance will have been written by the writeObject(ObjectOutput, Object) method. Implementations are free to create instances of the object read from the stream in any way that they feel like. This could be via constructor, factory or reflection.
      Parameters:
      input - the object input from which to read
      Returns:
      the object instance
      Throws:
      IOException - if an I/O error occurs
      ClassNotFoundException - if a class could not be found

    • getTargetClass

      Class<T> getTargetClass()
      Returns the target class of the object to externalize.
      Returns:
      a class to be externalized

    • size

      default OptionalInt size(T object)
      Returns the size of the buffer to use for marshalling the specified object, if known.
      Returns:
      the buffer size (in bytes), or empty if unknown.