Interface ByteBufferMarshaller

All Superinterfaces:
Marshallability, Marshaller<Object,ByteBuffer>

public interface ByteBufferMarshaller extends Marshaller<Object,ByteBuffer>
Marshals an object to and from a ByteBuffer.
Author:
Paul Ferraro
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.jboss.logging.Logger
     

    Fields inherited from interface org.wildfly.clustering.marshalling.Marshallability

    TRUE
  • Method Summary

    Modifier and Type
    Method
    Description
    default Object
    read(ByteBuffer buffer)
    Reads a value from its marshalled form.
    Reads an object from the specified input stream.
    default OptionalInt
    size(Object object)
    Returns the marshalled size of the specified object.
    default ByteBuffer
    write(Object object)
    Writes a value to its serialized form
    void
    writeTo(OutputStream output, Object object)
    Writes the specified object to the specified output stream.

    Methods inherited from interface org.wildfly.clustering.marshalling.Marshallability

    isMarshallable
  • Field Details

    • LOGGER

      static final org.jboss.logging.Logger LOGGER
  • Method Details

    • readFrom

      Object readFrom(InputStream input) throws IOException
      Reads an object from the specified input stream.
      Parameters:
      input - an input stream
      Returns:
      the unmarshalled object
      Throws:
      IOException - if the object could not be read
    • writeTo

      void writeTo(OutputStream output, Object object) throws IOException
      Writes the specified object to the specified output stream.
      Parameters:
      output - an output stream
      object - an object to marshal
      Throws:
      IOException - if the object could not be written
    • read

      default Object read(ByteBuffer buffer) throws IOException
      Description copied from interface: Marshaller
      Reads a value from its marshalled form.
      Specified by:
      read in interface Marshaller<Object,ByteBuffer>
      Parameters:
      buffer - the marshalled form
      Returns:
      an unmarshalled value/
      Throws:
      IOException
    • write

      default ByteBuffer write(Object object) throws IOException
      Description copied from interface: Marshaller
      Writes a value to its serialized form
      Specified by:
      write in interface Marshaller<Object,ByteBuffer>
      Returns:
      the serialized form of the value
      Throws:
      IOException
    • size

      default OptionalInt size(Object object)
      Returns the marshalled size of the specified object.
      Parameters:
      buffer - a byte buffer
      Returns:
      the marshalled size of the specified object.