org.assertj.swing.driver.AbstractButtonDriver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of assertj-swing Show documentation
Assertj-Swing test framework
The newest version!
/*
 * 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.
 *
 * Copyright 2012-2018 the original author or authors.
 */
package org.assertj.swing.driver;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.util.Preconditions.checkNotNull;
import static org.assertj.swing.driver.AbstractButtonArmedQuery.isArmed;
import static org.assertj.swing.driver.AbstractButtonSelectedQuery.isSelected;
import static org.assertj.swing.driver.ComponentPreconditions.checkEnabledAndShowing;
import static org.assertj.swing.driver.TextAssert.verifyThat;
import static org.assertj.swing.edt.GuiActionRunner.execute;

import java.util.regex.Pattern;

import javax.swing.AbstractButton;

import org.assertj.core.description.Description;
import org.assertj.swing.annotation.RunsInEDT;
import org.assertj.swing.core.Robot;
import org.assertj.swing.internal.annotation.InternalApi;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * 
 * Supports functional testing of Swing {@code AbstractButton}s.
 * 
 *
 * 
 * Note: This class is intended for internal use only. Please use the classes in the package
 * {@link org.assertj.swing.fixture} in your tests.
 * 
 *
 * @author Alex Ruiz
 * @author Yvonne Wang
 */
@InternalApi
public class AbstractButtonDriver extends JComponentDriver implements TextDisplayDriver {
  private static final String SELECTED_PROPERTY = "selected";
  private static final String ARMED_PROPERTY = "armed";
  private static final String TEXT_PROPERTY = "text";

  /**
   * Creates a new {@link AbstractButtonDriver}.
   *
   * @param robot the robot to use to simulate user input.
   */
  public AbstractButtonDriver(@NotNull Robot robot) {
    super(robot);
  }

  /**
   * Asserts that the text in the given Swing {@code AbstractButton} is equal to or matches the specified {@code String}
   * .
   *
   * @param button the given {@code AbstractButton}.
   * @param expected the text to match. It can be a regular expression.
   * @throws AssertionError if the text of the {@code AbstractButton} is not equal to or does not match the given one.
   */
  @RunsInEDT
  @Override
  public void requireText(@NotNull AbstractButton button, @Nullable String expected) {
    verifyThat(textOf(button)).as(propertyName(button, TEXT_PROPERTY)).isEqualOrMatches(expected);
  }

  /**
   * Asserts that the text in the given Swing {@code AbstractButton} matches the given regular expression pattern.
   *
   * @param button the given {@code AbstractButton}.
   * @param pattern the regular expression pattern to match.
   * @throws NullPointerException if the given regular expression pattern is {@code null}.
   * @throws AssertionError if the text of the {@code AbstractButton} does not match the given regular expression
   *           pattern.
   */
  @Override
  public void requireText(@NotNull AbstractButton button, @NotNull Pattern pattern) {
    verifyThat(textOf(button)).as(propertyName(button, TEXT_PROPERTY)).matches(pattern);
  }

  /**
   * Returns the text of the given Swing {@code AbstractButton}.
   *
   * @param button the given {@code AbstractButton}.
   * @return the text of the given {@code AbstractButton}.
   */
  @RunsInEDT
  @Override
  @NotNull
  public String textOf(@NotNull AbstractButton button) {
    return AbstractButtonTextQuery.textOf(button);
  }

  /**
   * Selects the given Swing {@code AbstractButton} only it is not already selected.
   *
   * @param button the target {@code AbstractButton}.
   * @throws IllegalStateException if the {@code AbstractButton} is disabled.
   * @throws IllegalStateException if the {@code AbstractButton} is not showing on the screen.
   */
  @RunsInEDT
  public void select(@NotNull AbstractButton button) {
    if (checkSelected(button)) {
      return;
    }
    robot.click(button);
  }

  /**
   * Deselects the given Swing {@code AbstractButton} only if it is selected.
   *
   * @param button the target {@code AbstractButton}.
   * @throws IllegalStateException if the {@code AbstractButton} is disabled.
   * @throws IllegalStateException if the {@code AbstractButton} is not showing on the screen.
   */
  @RunsInEDT
  public void deselect(@NotNull AbstractButton button) {
    if (!checkSelected(button)) {
      return;
    }
    robot.click(button);
  }

  @RunsInEDT
  private static boolean checkSelected(final @NotNull AbstractButton button) {
    Boolean result = execute(() -> {
      checkEnabledAndShowing(button);
      return button.isSelected();
    });
    return checkNotNull(result);
  }

  /**
   * Verifies that the Swing {@code AbstractButton} is selected.
   *
   * @param button the given {@code AbstractButton}.
   * @throws AssertionError if the button is not selected.
   */
  @RunsInEDT
  public void requireSelected(@NotNull AbstractButton button) {
    assertThatButtonIsSelected(button, true);
  }

  /**
   * Verifies that the {@code AbstractButton} is not selected.
   *
   * @param button the given {@code AbstractButton}.
   * @throws AssertionError if the {@code AbstractButton} is selected.
   */
  @RunsInEDT
  public void requireNotSelected(@NotNull AbstractButton button) {
    assertThatButtonIsSelected(button, false);
  }

  @RunsInEDT
  private void assertThatButtonIsSelected(@NotNull AbstractButton button, boolean selected) {
    assertThat(isSelected(button)).as(selectedProperty(button)).isEqualTo(selected);
  }

  @RunsInEDT
  @NotNull
  private static Description selectedProperty(@NotNull AbstractButton button) {
    return propertyName(button, SELECTED_PROPERTY);
  }

  /**
   * Verifies that the Swing {@code AbstractButton} is armed.
   *
   * @param button the given {@code AbstractButton}.
   * @throws AssertionError if the button is not armed.
   */
  @RunsInEDT
  public void requireArmed(@NotNull AbstractButton button) {
    assertThatButtonIsArmed(button, true);
  }

  /**
   * Verifies that the {@code AbstractButton} is not armed.
   *
   * @param button the given {@code AbstractButton}.
   * @throws AssertionError if the {@code AbstractButton} is armed.
   */
  @RunsInEDT
  public void requireNotArmed(@NotNull AbstractButton button) {
    assertThatButtonIsArmed(button, false);
  }

  @RunsInEDT
  private void assertThatButtonIsArmed(@NotNull AbstractButton button, boolean armed) {
    assertThat(isArmed(button)).as(armedProperty(button)).isEqualTo(armed);
  }

  @RunsInEDT
  @NotNull
  private static Description armedProperty(@NotNull AbstractButton button) {
    return propertyName(button, ARMED_PROPERTY);
  }
}