org.opentcs.kernel.vehicles.SplitResources Maven / Gradle / Ivy

Go to download
// SPDX-FileCopyrightText: The openTCS Authors
// SPDX-License-Identifier: MIT
package org.opentcs.kernel.vehicles;

import static java.util.Objects.requireNonNull;

import jakarta.annotation.Nonnull;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import org.opentcs.data.model.TCSResource;

/**
 * A vehicle's resources, split into resources the vehicle has already passed (including the
 * resources for the vehicle's current position) and resources that still lay ahead of it.
 */
public class SplitResources {

  private final List>> resourcesPassed;
  private final List>> resourcesAhead;

  /**
   * Creates a new instance.
   *
   * @param resourcesPassed The passed resources, including the ones for the vehicle's current
   * position.
   * @param resourcesAhead The resources ahead of the vehicle.
   */
  public SplitResources(
      @Nonnull
      List>> resourcesPassed,
      @Nonnull
      List>> resourcesAhead
  ) {
    this.resourcesPassed = requireNonNull(resourcesPassed, "resourcesPassed");
    this.resourcesAhead = requireNonNull(resourcesAhead, "resourcesAhead");
  }

  /**
   * Returns the resources the vehicle has already passed, from oldest to youngest, with the
   * youngest being the resources for the vehicle's current position.
   *
   * @return The resources the vehicle has already passed, from oldest to youngest, with the
   * youngest being the resources for the vehicle's current position.
   */
  public List>> getResourcesPassed() {
    return resourcesPassed;
  }

  /**
   * Returns the resources ahead of the vehicle, from oldest to youngest.
   *
   * @return The resources ahead of the vehicle, from oldest to youngest.
   */
  public List>> getResourcesAhead() {
    return resourcesAhead;
  }

  /**
   * Returns a new instance created from the given iterable of resources, split at the element that
   * contains the given delimiter (resources).
   *
   * @param resourceSets The iterable of resources to be split, from oldest to youngest.
   * @param delimiter The delimiter / resources for the vehicle's current position.
   * @return A new instance created from the given iterable of resources, split at the element that
   * contains the given delimiter (resources).
   */
  public static SplitResources from(
      @Nonnull
      Iterable>> resourceSets,
      @Nonnull
      Set> delimiter
  ) {
    requireNonNull(resourceSets, "resourceSets");
    requireNonNull(delimiter, "delimiter");

    List>> resourcesPassed = new ArrayList<>();
    List>> resourcesAhead = new ArrayList<>();
    List>> resourcesToPutIn = resourcesPassed;

    for (Set> curSet : resourceSets) {
      resourcesToPutIn.add(curSet);

      if (!delimiter.isEmpty() && curSet.containsAll(delimiter)) {
        resourcesToPutIn = resourcesAhead;
      }
    }

    return new SplitResources(resourcesPassed, resourcesAhead);
  }

}