org.opentcs.access.SchedulerAllocationState Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.access;

import java.io.Serializable;
import java.util.Collections;
import java.util.Map;
import static java.util.Objects.requireNonNull;
import java.util.Set;
import javax.annotation.Nonnull;
import org.opentcs.data.model.TCSResource;

/**
 * Represents the current state of resource allocations.
 *
 * @author Martin Grzenia (Fraunhofer IML)
 */
public class SchedulerAllocationState
    implements Serializable {

  /**
   * The current state of allocations.
   */
  private final Map>> allocationStates;

  /**
   * Creates a new instance.
   *
   * @param allocationStates The current state of allocations.
   */
  public SchedulerAllocationState(@Nonnull Map>> allocationStates) {
    this.allocationStates = Collections.unmodifiableMap(requireNonNull(allocationStates,
                                                                       "allocationStates"));
  }

  /**
   * Returns the current state of allocations.
   *
   * @return The current state of allocations.
   */
  public Map>> getAllocationStates() {
    return allocationStates;
  }
}