io.activej.codec.StructuredCodec Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of activej-codec Show documentation

Tools for encoding/decoding custom objects.

There is a newer version: 4.4-rc1

/*
 * 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.codec;

import io.activej.common.api.DecoderFunction;
import io.activej.common.exception.MalformedDataException;
import org.jetbrains.annotations.Nullable;

import java.util.List;
import java.util.function.Function;
import java.util.function.Supplier;

/**
 * A structured codec is an object that describes how some type T
 * can be written into {@link StructuredOutput} or read from {@link StructuredInput}.
 * The actual representation is abstracted away, so the same codec can be used to write or read
 * an object into/from various formats and protocols.
 */
public interface StructuredCodec extends StructuredEncoder, StructuredDecoder {

	static  StructuredCodec of(StructuredDecoder decoder, StructuredEncoder encoder) {
		return new StructuredCodec() {
			@Override
			public void encode(StructuredOutput out, T item) {
				encoder.encode(out, item);
			}

			@Override
			public T decode(StructuredInput in) throws MalformedDataException {
				return decoder.decode(in);
			}
		};
	}

	static  StructuredCodec ofObject(StructuredDecoder decoder, StructuredEncoder encoder) {
		return of(StructuredDecoder.ofObject(decoder), StructuredEncoder.ofObject(encoder));
	}

	static  StructuredCodec ofObject(Supplier supplier) {
		return of(StructuredDecoder.ofObject(supplier), StructuredEncoder.ofObject());
	}

	static  StructuredCodec ofTuple(StructuredDecoder decoder, StructuredEncoder encoder) {
		return of(StructuredDecoder.ofTuple(decoder), StructuredEncoder.ofTuple(encoder));
	}

	default StructuredCodec<@Nullable T> nullable() {
		return StructuredCodecs.ofNullable(this);
	}

	default StructuredCodec> ofList() {
		return StructuredCodecs.ofList(this);
	}

	default  StructuredCodec transform(DecoderFunction reader, Function writer) {
		return StructuredCodecs.transform(this, reader, writer);
	}

}