src/main/java/com/google/devtools/build/lib/packages/PackageSerializerInterface.java

// Copyright 2018 The Bazel Authors. All rights reserved.
//
// 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.google.devtools.build.lib.packages;

import com.google.devtools.build.lib.skyframe.serialization.SerializationContext;
import com.google.devtools.build.lib.skyframe.serialization.SerializationException;
import com.google.protobuf.CodedOutputStream;
import java.io.IOException;

/**
 * Abstraction layer for Package serialization.
 *
 * <p>Provides a layer of indirection for breaking circular dependencies.
 */
public interface PackageSerializerInterface {
  /**
   * Serialize a package to {@code codedOut}. The inverse of {@link
   * PackageDeserializer#deserialize}.
   *
   * @param pkg the {@link Package} to be serialized
   * @param codedOut the stream to write {@code pkg}'s serialized representation to
   * @throws IOException on failure writing to {@code codedOut}
   */
  void serialize(SerializationContext context, Package pkg, CodedOutputStream codedOut)
      throws SerializationException, IOException;
}