package org.opentrafficsim.base.parameters.constraint;
   
   import java.util.Collection;
   
   import org.djutils.exceptions.Throw;
   
   /**
    * Constraint that checks whether a value is in a given constraint collection.
    * <p>
   * Copyright (c) 2013-2026 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
   * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
   * </p>
   * @author Alexander Verbraeck
   * @author Peter Knoppers
   * @author Wouter Schakel
   * @param <T> value type
   */
  public class CollectionConstraint<T> implements Constraint<T>
  {
  
      /** Acceptable objects. */
      @SuppressWarnings("checkstyle:visibilitymodifier")
      protected final Collection<T> objects;
  
      /**
       * Constructor.
       * @param objects acceptable objects
       */
      public CollectionConstraint(final Collection<T> objects)
      {
          Throw.whenNull(objects, "Collection of acceptable objects may not be null.");
          this.objects = objects;
      }
  
      @Override
      public boolean accept(final T value)
      {
          return this.objects.contains(value);
      }
  
      @Override
      public String failMessage()
      {
          return "Value of parameter '%s' is not in the collection of acceptable values.";
      }
  
      @Override
      public String toString()
      {
          return "CollectionConstraint [objects=" + this.objects + "]";
      }
  
  }