/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.spark.network.shuffle.protocol;

import java.util.Objects;

import io.netty.buffer.ByteBuf;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;

// Needed by ScalaDoc. See SPARK-7726
import static org.apache.spark.network.shuffle.protocol.BlockTransferMessage.Type;

/** The reply to remove blocks giving back the number of removed blocks. */
public class BlocksRemoved extends BlockTransferMessage {
  public final int numRemovedBlocks;

  public BlocksRemoved(int numRemovedBlocks) {
    this.numRemovedBlocks = numRemovedBlocks;
  }

  @Override
  protected Type type() { return Type.BLOCKS_REMOVED; }

  @Override
  public int hashCode() {
    return Objects.hashCode(numRemovedBlocks);
  }

  @Override
  public String toString() {
    return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)
      .append("numRemovedBlocks", numRemovedBlocks)
      .toString();
  }

  @Override
  public boolean equals(Object other) {
    if (other instanceof BlocksRemoved o) {
      return numRemovedBlocks == o.numRemovedBlocks;
    }
    return false;
  }

  @Override
  public int encodedLength() {
    return 4;
  }

  @Override
  public void encode(ByteBuf buf) {
    buf.writeInt(numRemovedBlocks);
  }

  public static BlocksRemoved decode(ByteBuf buf) {
    int numRemovedBlocks = buf.readInt();
    return new BlocksRemoved(numRemovedBlocks);
  }
}
