com.helger.phive.api.executorset.IValidationExecutorSet 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

There is a newer version: 10.0.2

/*
 * 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 javax.annotation.Nonnull;

import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.annotation.ReturnsMutableObject;
import com.helger.commons.collection.impl.ICommonsIterable;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.id.IHasID;
import com.helger.commons.name.IHasDisplayName;
import com.helger.diver.api.version.VESID;
import com.helger.phive.api.execute.IValidationExecutor;
import com.helger.phive.api.executorset.status.IValidationExecutorSetStatus;
import com.helger.phive.api.source.IValidationSource;

/**
 * Read-only interface for a named list of {@link IValidationExecutor}.
 *
 * @author Philip Helger
 * @param 
 *        The validation source type to be used.
 */
public interface IValidationExecutorSet  extends
                                        IHasID ,
                                        IHasDisplayName,
                                        ICommonsIterable >
{
  /**
   * @return A list with all validation executors. Never null but
   *         maybe empty.
   */
  @Nonnull
  @ReturnsMutableObject
  ICommonsList > executors ();

  /**
   * @return A list with all validation executors. Never null but
   *         maybe empty.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsList > getAllExecutors ();

  /**
   * @return true if this document is deprecated (phased-out or end
   *         of life)?
   * @see #getStatus()
   */
  @Deprecated (forRemoval = true, since = "9.2.0")
  default boolean isDeprecated ()
  {
    return getStatus ().isDeprecated ();
  }

  /**
   * @return The VES status. Never null.
   */
  @Nonnull
  IValidationExecutorSetStatus getStatus ();
}