com.spotify.apollo.entity.Codec Maven / Gradle / Ivy

/*
 * -\-\-
 * Spotify Apollo Entity Middleware
 * --
 * Copyright (C) 2013 - 2018 Spotify AB
 * --
 * 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 com.spotify.apollo.entity;

import com.spotify.apollo.Exploratory;
import com.spotify.apollo.RequestContext;
import java.io.IOException;
import okio.ByteString;

/**
 * Interface for serializing and de-serializing entities to and from a {@link ByteString}.
 *
 * A {@link Codec} can be used by a {@link EntityMiddleware} to do the actual entity
 * serialization.
 */
@Exploratory
public interface Codec {

   EncodedResponse write(E entity, Class cls, RequestContext ctx) throws IOException;

   E read(ByteString data, Class cls, RequestContext ctx) throws IOException;
}