third-party/atomix/storage/src/main/java/io/atomix/utils/serializer/Serializer.java

   1 /*
   2  * Copyright 2015-present Open Networking Foundation
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package io.atomix.utils.serializer;
  18
  19 /**
  20  * Interface for serialization of store artifacts.
  21  */
  22 public interface Serializer {
  23
  24   /**
  25    * Creates a new serializer builder.
  26    *
  27    * @return a new serializer builder
  28    */
  29   static SerializerBuilder builder() {
  30     return new SerializerBuilder();
  31   }
  32
  33   /**
  34    * Creates a new serializer builder.
  35    *
  36    * @param name the serializer name
  37    * @return a new serializer builder
  38    */
  39   static SerializerBuilder builder(String name) {
  40     return new SerializerBuilder(name);
  41   }
  42
  43   /**
  44    * Serialize the specified object.
  45    *
  46    * @param object object to serialize.
  47    * @param <T>    encoded type
  48    * @return serialized bytes.
  49    */
  50   <T> byte[] encode(T object);
  51
  52   /**
  53    * Deserialize the specified bytes.
  54    *
  55    * @param bytes byte array to deserialize.
  56    * @param <T>   decoded type
  57    * @return deserialized object.
  58    */
  59   <T> T decode(byte[] bytes);
  60
  61   /**
  62    * Creates a new Serializer instance from a Namespace.
  63    *
  64    * @param namespace serializer namespace
  65    * @return Serializer instance
  66    */
  67   static Serializer using(Namespace namespace) {
  68     return new Serializer() {
  69       @Override
  70       public <T> byte[] encode(T object) {
  71         return namespace.serialize(object);
  72       }
  73
  74       @Override
  75       public <T> T decode(byte[] bytes) {
  76         return namespace.deserialize(bytes);
  77       }
  78     };
  79   }
  80
  81 }