/**
 * 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.core;

import static org.assertj.core.util.Preconditions.checkNotNull;

import java.awt.Component;

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

import org.assertj.swing.annotation.RunsInCurrentThread;

/**
 * Matches AWT or Swing {@code Component}s by type.
 * 
 * @author Alex Ruiz
 */
public final class TypeMatcher extends AbstractComponentMatcher {
  private final Class<? extends Component> type;

  /**
   * Creates a new {@link TypeMatcher}. The AWT or Swing {@code Component} to match does not have to be showing.
   * 
   * @param type the type of the {@code Component} we are looking for.
   * @throws NullPointerException if the given type is {@code null}.
   */
  public TypeMatcher(@Nonnull Class<? extends Component> type) {
    this(type, false);
  }

  /**
   * Creates a new {@link TypeMatcher}.
   * 
   * @param type the type of the AWT or Swing {@code Component} we are looking for.
   * @param requireShowing indicates if the {@code Component} to match should be showing or not.
   * @throws NullPointerException if the given type is {@code null}.
   */
  public TypeMatcher(@Nonnull Class<? extends Component> type, boolean requireShowing) {
    super(requireShowing);
    this.type = checkNotNull(type);
  }

  /**
   * <p>
   * Indicates whether the type and visibility of the given AWT or Swing {@code Component} matches the value specified
   * in this matcher.
   * </p>
   * 
   * <p>
   * <b>Note:</b> 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.
   * </p>
   * 
   * @return {@code true} if the type and visibility of the given {@code Component} matches the values specified in this
   *         matcher, {@code false} otherwise.
   */
  @Override
  @RunsInCurrentThread
  public boolean matches(@Nullable Component c) {
    if (c == null) {
      return false;
    }
    return type.isAssignableFrom(c.getClass()) && requireShowingMatches(c);
  }

  @Override
  public String toString() {
    return String.format("%s[type=%s, requireShowing=%b]", getClass().getName(), type.getName(), requireShowing());
  }
}