io.activej.serializer.def.SerializerDef Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2020 ActiveJ LLC.
 *
 * 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.activej.serializer.def;

import io.activej.codegen.expression.Expression;
import io.activej.codegen.expression.Variable;
import io.activej.serializer.CompatibilityLevel;

import java.util.Set;

import static io.activej.codegen.expression.Expressions.arg;

/**
 * Represents a serializer and deserializer of a particular class to byte arrays
 */
public interface SerializerDef {

	interface Visitor {
		void visit(String serializerId, SerializerDef serializer);

		default void visit(SerializerDef serializer) {
			visit("", serializer);
		}
	}

	void accept(Visitor visitor);

	Set getVersions();

	/**
	 * Returns the raw type of object which will be serialized
	 *
	 * @return type of object which will be serialized
	 */
	Class getEncodeType();

	Class getDecodeType();

	boolean isInline(int version, CompatibilityLevel compatibilityLevel);

	Expression encode(StaticEncoders staticEncoders, Expression buf, Variable pos, Expression value, int version, CompatibilityLevel compatibilityLevel);

	Expression decode(StaticDecoders staticDecoders, Expression in, int version, CompatibilityLevel compatibilityLevel);

	interface StaticEncoders {
		Expression BUF = arg(0);
		Variable POS = arg(1);
		Variable VALUE = arg(2);

		Encoder define(SerializerDef serializerDef);
	}

	interface StaticDecoders {
		Variable IN = arg(0);

		Decoder define(SerializerDef serializerDef);
	}

	interface Encoder {
		/**
		 * Serializes provided {@link Expression} {@code value} to byte array
		 *
		 * @param buf   byte array to which the value will be serialized
		 * @param pos   an offset in the byte array
		 * @param value the value to be serialized to byte array
		 * @return serialized to byte array value
		 */
		Expression encode(Expression buf, Variable pos, Expression value);
	}

	default Encoder defineEncoder(StaticEncoders staticEncoders, int version, CompatibilityLevel compatibilityLevel) {
		return isInline(version, compatibilityLevel) ?
			(buf, pos, value) -> encode(null, buf, pos, value, version, compatibilityLevel) :
			staticEncoders.define(this);
	}

	interface Decoder {
		/**
		 * Serializes provided {@link Expression} {@code value} to byte array
		 *
		 * @param in BinaryInput
		 * @return serialized to byte array value
		 */
		Expression decode(Expression in);
	}

	default Decoder defineDecoder(StaticDecoders staticDecoders, int version, CompatibilityLevel compatibilityLevel) {
		return isInline(version, compatibilityLevel) ?
			in -> decode(null, in, version, compatibilityLevel) :
			staticDecoders.define(this);
	}
}