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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of infinispan-embedded

Infinispan Embedded All-in-One module

There is a newer version: 9.1.7.Final

package org.infinispan.protostream;

/**
 * Contract to be implemented by marshallers for enum types. Translates a Java enum into an {@code int} value that is
 * suitable for serializing with protobuf. The returned integer value must be one of the values defined in the .proto
 * file. The marshaller implementation must be stateless and thread-safe.
 *
 * @author [email protected]
 * @since 1.0
 */
public interface EnumMarshaller> extends BaseMarshaller {

   /**
    * Decodes an integer enum value read from a protobuf encoded stream into a Java enum instance. If the numeric value
    * is not recognized the method must return {@code null} in order to signal this to the library and allow the
    * unrecognized data to be preserved.
    *
    * @param enumValue the protobuf enum value to decode
    * @return a Java enum instance if the value is recognized or {@code null} otherwise.
    */
   E decode(int enumValue);

   /**
    * Encodes a Java enum into its corresponding protobuf numeric value.
    *
    * @param e an Enum instance
    * @return the corresponding numeric value from the protobuf definition of the enum.
    * @throws IllegalArgumentException if the given Enum is of an unexpected type or its value has no correspondence to
    *                                  a protobuf enum value (programming error).
    */
   int encode(E e) throws IllegalArgumentException;
}