org.assertj.swing.driver.ComponentPreconditions 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
Fluent interface for functional GUI testing
There is a newer version: 3.17.1
/**
 * 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-2015 the original author or authors.
 */
package org.assertj.swing.driver;

import static org.assertj.core.util.Strings.concat;
import static org.assertj.swing.format.Formatting.format;

import java.awt.Component;

import javax.annotation.Nonnull;

import org.assertj.swing.annotation.RunsInCurrentThread;

/**
 * Verifies correct state of a {@code Component}.
 * 
 * @author Alex Ruiz
 */
public final class ComponentPreconditions {
  /**
   * 
   * Verifies that the {@code Component} is enabled and showing.
   * 
   * 
   * 
   * Note: This method is accessed in the current executing thread. Such thread may or may not be the event
   * dispatch thread (EDT). Client code must call this method from the EDT.
   * 
   * 
   * @param c the target component.
   * @throws IllegalStateException if the {@code Component} is disabled.
   * @throws IllegalStateException if the {@code Component} is not showing on the screen.
   */
  @RunsInCurrentThread
  public static void checkEnabledAndShowing(@Nonnull Component c) {
    checkEnabled(c);
    checkShowing(c);
  }

  /**
   * 
   * Verifies that the {@code Component} is enabled.
   * 
   * 
   * 
   * Note: This method is accessed in the current executing thread. Such thread may or may not be the event
   * dispatch thread (EDT). Client code must call this method from the EDT.
   * 
   * 
   * @param c the target component.
   * @throws IllegalStateException if the {@code Component} is disabled.
   */
  @RunsInCurrentThread
  public static void checkEnabled(@Nonnull Component c) {
    if (!c.isEnabled()) {
      throw new IllegalStateException(concat("Expecting component ", format(c), " to be enabled"));
    }
  }

  /**
   * 
   * Verifies that the {@code Component} is showing on the screen.
   * 
   * 
   * 
   * Note: This method is accessed in the current executing thread. Such thread may or may not be the event
   * dispatch thread (EDT). Client code must call this method from the EDT.
   * 
   * 
   * @param c the target component.
   * @throws IllegalStateException if the {@code Component} is not showing on the screen.
   */
  @RunsInCurrentThread
  public static void checkShowing(@Nonnull Component c) {
    if (!c.isShowing()) {
      String msg = String.format("Expecting component %s to be showing on the screen", format(c));
      throw new IllegalStateException(msg);
    }
  }

  private ComponentPreconditions() {
  }
}