io.ryos.rhino.sdk.dsl.IterableDsl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rhino-core Show documentation
The newest version!
/*
 * Copyright 2020 Ryos.io.
 *
 * 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 io.ryos.rhino.sdk.dsl;

import io.ryos.rhino.sdk.data.UserSession;
import io.ryos.rhino.sdk.dsl.SessionDslItem.Scope;
import io.ryos.rhino.sdk.dsl.data.builder.ForEachBuilder;
import java.util.function.Function;
import java.util.function.Predicate;

/**
 * Load DSL to describe iterable operations.
 *
 * @author Erhan Bagdemir
 */
public interface IterableDsl extends DslItem {

  , T extends MaterializableDslItem> DslBuilder forEach(
      R iterable, Function dslItemExtractor);

  , T extends MaterializableDslItem> DslBuilder forEach(
      final Function iterableExtractor,
      final Function dslItemExtractor);

  /**
   * For-each DSL spec loops through the sequence of elements built by {@link ForEachBuilder}
   * instance.
   *
   * @param forEachBuilder Iterable builder.
   * @return {@link DslBuilder} runnable DSL instance.
   */
  , T extends MaterializableDslItem> DslBuilder forEach(
      ForEachBuilder forEachBuilder);

  /**
   * Runs the {@link MaterializableDslItem} till the {@link Predicate} holds.
   *
   * @param predicate Run conditional.
   * @param spec      {@link MaterializableDslItem} to run.
   * @return {@link DslBuilder} runnable DSL instance.
   */
  DslBuilder until(Predicate predicate, MaterializableDslItem spec);

  /**
   * Runs the {@link MaterializableDslItem} as long as the {@link Predicate} holds.
   *
   * @param predicate Run conditional.
   * @param spec      {@link MaterializableDslItem} to run.
   * @return {@link DslBuilder} runnable DSL instance.
   */
  DslBuilder asLongAs(Predicate predicate, MaterializableDslItem spec);

  /**
   * Runs the {@link MaterializableDslItem} repeatedly.
   *
   * @param spec {@link MaterializableDslItem} to run.
   * @return {@link DslBuilder} runnable DSL instance.
   */
  DslBuilder repeat(MaterializableDslItem spec);

  DslBuilder repeat(MaterializableDslItem spec, int times);
}