com.helger.phive.api.executorset.IValidationExecutorSetRegistry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phive-api Show documentation
phive - Philip Helger Integrative Validation Engine API
The newest version!
/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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.
 */
package com.helger.phive.api.executorset;

import java.time.OffsetDateTime;
import java.util.function.Predicate;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.state.EChange;
import com.helger.diver.api.coord.DVRCoordinate;
import com.helger.phive.api.diver.IPseudoVersionResolver;
import com.helger.phive.api.source.IValidationSource;

/**
 * Read-only interface for a registry of {@link IValidationExecutorSet} objects.
 *
 * @author Philip Helger
 * @since 6.0.0
 * @param 
 *        The validation source type to be used.
 */
public interface IValidationExecutorSetRegistry  extends
                                                IPseudoVersionResolver >
{
  /**
   * @return true if the resolution of pseudo versions (like e.g.
   *         "latest") should be performed or not. By default this is enabled.
   * @since 8.0.1
   */
  boolean isResolvePseudoVersions ();

  /**
   * Enable or disable the resolving of pseudo versions.
   *
   * @param b
   *        true to enable it, false to disable it.
   * @since 8.0.1
   */
  void setResolvePseudoVersions (boolean b);

  /**
   * Register a validation executor set into this registry.
   *
   * @param aVES
   *        The object to register. May not be null.
   * @throws IllegalStateException
   *         If another object with the same ID is already registered in this
   *         registry.
   */
  void registerValidationExecutorSet (@Nonnull IValidationExecutorSet  aVES);

  /**
   * Unregister a validation executor set from this registry. This basically
   * removes the VES from the internal map. The removed VES are not modified in
   * any way and can theoretically be re-registered afterwards.
   *
   * @param aVES
   *        The object to unregister. May be null.
   * @return {@link EChange#CHANGED} if the removal was successful,
   *         {@link EChange#UNCHANGED} otherwise.
   * @since 6.0.1
   */
  @Nonnull
  default EChange unregisterValidationExecutorSet (@Nullable final IValidationExecutorSet  aVES)
  {
    return aVES == null ? EChange.UNCHANGED : unregisterValidationExecutorSet (aVES.getID ());
  }

  /**
   * Unregister a validation executor set from this registry. This basically
   * removes the VES from the internal map. The removed VES are not modified in
   * any way and can theoretically be re-registered afterwards.
   *
   * @param aVESID
   *        The VESID of the object to unregister. May be null.
   * @return {@link EChange#CHANGED} if the removal was successful,
   *         {@link EChange#UNCHANGED} otherwise.
   * @since 6.0.1
   */
  @Nonnull
  EChange unregisterValidationExecutorSet (@Nullable DVRCoordinate aVESID);

  /**
   * @return A list of all contained validation executor sets in this registry.
   *         Never null but maybe empty.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsList > getAll ();

  /**
   * Find all validation executor sets that match the provided filter.
   *
   * @param aFilter
   *        The filter to be used. May be null in which case the
   *        result is the same as {@link #getAll()}.
   * @return Never null but maybe empty.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsList > findAll (@Nonnull Predicate > aFilter);

  /**
   * Find the first validation executor sets that match the provided filter.
   *
   * @param aFilter
   *        The filter to be used. May be null in which case the
   *        result is the same as {@link #getAll()}.
   * @return null if no match was found.
   */
  @Nullable
  IValidationExecutorSet  findFirst (@Nonnull Predicate > aFilter);

  /**
   * Find the validation executor set with the specified ID. This method
   * supports pseudo version.
   *
   * @param aVESID
   *        The VESID to search. May be null.
   * @return null if no such validation executor set is registered.
   */
  @Nullable
  IValidationExecutorSet  getOfID (@Nullable DVRCoordinate aVESID);

  /**
   * Find the validation executor set with the specified ID for the provided
   * point in time. This method supports pseudo version.
   *
   * @param aVESID
   *        The VESID to search. May be null.
   * @param aCheckDateTime
   *        The date and time for which the version should be resolved. If
   *        null if provided, the current point in time is used.
   * @return null if no such validation executor set is registered.
   * @since 9.2.1
   */
  @Nullable
  IValidationExecutorSet  getOfID (@Nullable DVRCoordinate aVESID, @Nullable OffsetDateTime aCheckDateTime);
}