org.openqa.selenium.interactions.CompositeAction Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of selenium-api Show documentation

Selenium automates browsers. That's it! What you do with that power is entirely up to you.

There is a newer version: 4.19.1

// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you 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 org.openqa.selenium.interactions;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

/**
 * An action for aggregating actions and triggering all of them at the same time.
 *
 */
public class CompositeAction implements Action, IsInteraction {
  private final List actionsList = new ArrayList<>();

  @Override
  public void perform() {
    for (Action action : actionsList) {
      action.perform();
    }
  }

  public CompositeAction addAction(Action action) {
    Objects.requireNonNull(action, "Null actions are not supported.");
    actionsList.add(action);
    return this;
  }

  /**
   * @deprecated No replacement.
   */
  //VisibleForTesting
  @Deprecated
  int getNumberOfActions() {
    return actionsList.size();
  }

  @Override
  public List asInteractions(PointerInput mouse, KeyInput keyboard) {
    List interactions = new ArrayList<>();

    for (Action action : actionsList) {
      if (!(action instanceof IsInteraction)) {
        throw new IllegalArgumentException(
            String.format("Action must implement IsInteraction: %s", action));
      }

      interactions.addAll(((IsInteraction) action).asInteractions(mouse, keyboard));
    }

    return Collections.unmodifiableList(interactions);
  }
}