Import atomix/{storage,utils}
[controller.git] / third-party / atomix / utils / src / main / java / io / atomix / utils / serializer / Serializer.java
diff --git a/third-party/atomix/utils/src/main/java/io/atomix/utils/serializer/Serializer.java b/third-party/atomix/utils/src/main/java/io/atomix/utils/serializer/Serializer.java
new file mode 100644 (file)
index 0000000..ec3aa6f
--- /dev/null
@@ -0,0 +1,81 @@
+/*
+ * Copyright 2015-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.atomix.utils.serializer;
+
+/**
+ * Interface for serialization of store artifacts.
+ */
+public interface Serializer {
+
+  /**
+   * Creates a new serializer builder.
+   *
+   * @return a new serializer builder
+   */
+  static SerializerBuilder builder() {
+    return new SerializerBuilder();
+  }
+
+  /**
+   * Creates a new serializer builder.
+   *
+   * @param name the serializer name
+   * @return a new serializer builder
+   */
+  static SerializerBuilder builder(String name) {
+    return new SerializerBuilder(name);
+  }
+
+  /**
+   * Serialize the specified object.
+   *
+   * @param object object to serialize.
+   * @param <T>    encoded type
+   * @return serialized bytes.
+   */
+  <T> byte[] encode(T object);
+
+  /**
+   * Deserialize the specified bytes.
+   *
+   * @param bytes byte array to deserialize.
+   * @param <T>   decoded type
+   * @return deserialized object.
+   */
+  <T> T decode(byte[] bytes);
+
+  /**
+   * Creates a new Serializer instance from a Namespace.
+   *
+   * @param namespace serializer namespace
+   * @return Serializer instance
+   */
+  static Serializer using(Namespace namespace) {
+    return new Serializer() {
+      @Override
+      public <T> byte[] encode(T object) {
+        return namespace.serialize(object);
+      }
+
+      @Override
+      public <T> T decode(byte[] bytes) {
+        return namespace.deserialize(bytes);
+      }
+    };
+  }
+
+}