org.catools.web.collections.CWebIterable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of web.driver Show documentation

The Web Driver to be used in CATs projects for testing

The newest version!

package org.catools.web.collections;

import org.catools.common.collections.interfaces.CIterable;
import org.catools.common.extensions.types.interfaces.CDynamicIterableExtension;
import org.catools.web.controls.CWebElement;

import javax.ws.rs.NotSupportedException;
import java.util.Iterator;
import java.util.NoSuchElementException;

public interface CWebIterable> extends CIterable>, CDynamicIterableExtension {

  /**
   * The Zero based index which means the first record has index 0. In case if you want to use it in
   * your java code, you should decrement it for 0.
   *
   * @param idx
   * @return
   */
  E getRecord(int idx);

  /**
   * The Zero based index which means the first record has index 0. In case if you want to use it in
   * your java code, you should decrement it for 0. You really should not need to change this
   * method.
   *
   * @param idx
   * @return
   */
  boolean hasRecord(int idx);

  @SuppressWarnings("unchecked")
  @Override
  default Iterable _get() {
    return this;
  }

  @Override
  default boolean withWaiter() {
    return true;
  }

  @Override
  default Iterator iterator() {
    return new Iterator<>() {
      int cursor = 0;

      @Override
      public boolean hasNext() {
        return hasRecord(cursor);
      }

      @Override
      public E next() {
        if (!hasNext()) {
          throw new NoSuchElementException();
        }

        return getRecord(cursor++);
      }

      @Override
      public void remove() {
        throw new NotSupportedException();
      }
    };
  }
}