SyncTargetRange.java

/*
 * Copyright ConsenSys AG.
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package org.hyperledger.besu.ethereum.eth.sync.range;

import static java.lang.Math.toIntExact;

import org.hyperledger.besu.ethereum.core.BlockHeader;
import org.hyperledger.besu.ethereum.eth.manager.EthPeer;

import java.util.Objects;
import java.util.Optional;

import com.google.common.base.MoreObjects;

public class SyncTargetRange {

  private final EthPeer syncTarget;
  private final BlockHeader start;
  private final Optional<BlockHeader> end;

  public SyncTargetRange(final EthPeer syncTarget, final BlockHeader start) {
    this.syncTarget = syncTarget;
    this.start = start;
    this.end = Optional.empty();
  }

  public SyncTargetRange(final EthPeer syncTarget, final BlockHeader start, final BlockHeader end) {
    this.syncTarget = syncTarget;
    this.start = start;
    this.end = Optional.of(end);
  }

  public EthPeer getSyncTarget() {
    return syncTarget;
  }

  public BlockHeader getStart() {
    return start;
  }

  public boolean hasEnd() {
    return end.isPresent();
  }

  public BlockHeader getEnd() {
    return end.get();
  }

  public int getSegmentLengthExclusive() {
    return toIntExact(end.get().getNumber() - start.getNumber() - 1);
  }

  @Override
  public boolean equals(final Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    final SyncTargetRange that = (SyncTargetRange) o;
    return Objects.equals(syncTarget, that.syncTarget)
        && Objects.equals(start, that.start)
        && Objects.equals(end, that.end);
  }

  @Override
  public int hashCode() {
    return Objects.hash(syncTarget, start, end);
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(this)
        .add("syncTarget", syncTarget)
        .add("start", start)
        .add("end", end)
        .toString();
  }
}