org.assertj.swing.query.ComponentShowingQuery 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

/*
 * Created on Jul 1, 2008
 * 
 * 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 @2008-2013 the original author or authors.
 */
package org.assertj.swing.query;

import static org.assertj.core.util.Preconditions.checkNotNull;
import static org.assertj.swing.edt.GuiActionRunner.execute;

import java.awt.Component;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.assertj.swing.annotation.RunsInEDT;
import org.assertj.swing.edt.GuiQuery;

/**
 * Indicates whether an AWT or Swing {@code Component} is showing on the screen. This query is executed in the event
 * dispatch thread (EDT.)
 * 
 * @see Component#isShowing()
 * 
 * @author Alex Ruiz
 * @author Yvonne Wang
 */
public final class ComponentShowingQuery {
  /**
   * Indicates whether the given AWT or Swing {@code Component} is showing or not. This query is executed in the event
   * dispatch thread (EDT.)
   * 
   * @param component the given {@code Component}.
   * @return {@code true} if the given {@code Component} is showing, {@code false} otherwise.
   * @see Component#isShowing()
   */
  @RunsInEDT
  public static boolean isShowing(final @Nonnull Component component) {
    Boolean result = execute(new GuiQuery() {
      @Override
      protected @Nullable
      Boolean executeInEDT() {
        return component.isShowing();
      }
    });
    return checkNotNull(result);
  }

  private ComponentShowingQuery() {
  }
}