2 * Copyright 2015-present Open Networking Foundation
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 package io.atomix.utils.serializer;
20 * Interface for serialization of store artifacts.
22 public interface Serializer {
25 * Creates a new serializer builder.
27 * @return a new serializer builder
29 static SerializerBuilder builder() {
30 return new SerializerBuilder();
34 * Creates a new serializer builder.
36 * @param name the serializer name
37 * @return a new serializer builder
39 static SerializerBuilder builder(String name) {
40 return new SerializerBuilder(name);
44 * Serialize the specified object.
46 * @param object object to serialize.
47 * @param <T> encoded type
48 * @return serialized bytes.
50 <T> byte[] encode(T object);
53 * Deserialize the specified bytes.
55 * @param bytes byte array to deserialize.
56 * @param <T> decoded type
57 * @return deserialized object.
59 <T> T decode(byte[] bytes);
62 * Creates a new Serializer instance from a Namespace.
64 * @param namespace serializer namespace
65 * @return Serializer instance
67 static Serializer using(Namespace namespace) {
68 return new Serializer() {
70 public <T> byte[] encode(T object) {
71 return namespace.serialize(object);
75 public <T> T decode(byte[] bytes) {
76 return namespace.deserialize(bytes);