org.infinispan.protostream.UnknownFieldSetHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of protostream Show documentation

Users need to implement a marshaller object that interacts with a field writer/reader in order to serialize state.

There is a newer version: 14.0.0.CR2

package org.infinispan.protostream;

/**
 * An interface to be implemented by marshaller objects of type {@link MessageMarshaller}) that are able to handle
 * unknown fields by storing them into an {@link UnknownFieldSet}. {@link ProtobufTagMarshaller}s are expected to handle
 * unknown fields manually and cannot benefit from automatic handling by implementing this interface.
 *
 * @author [email protected]
 * @since 3.0
 * @deprecated since 4.3.1. This will be removed together with {@link MessageMarshaller}
 */
@Deprecated
public interface UnknownFieldSetHandler {

   /**
    * Extract the {@link UnknownFieldSet} that was previously attached to a message during unmarshalling.
    *
    * @return the UnknownFieldSet or {@code null}
    */
   UnknownFieldSet getUnknownFieldSet(T message);

   /**
    * Attach a non-empty {@link UnknownFieldSet} to a message that was newly unmarshalled.
    */
   void setUnknownFieldSet(T message, UnknownFieldSet unknownFieldSet);
}