org.assertj.swing.core

Class GenericTypeMatcher<T extends Component>

java.lang.Object

org.assertj.swing.core.AbstractComponentMatcher

org.assertj.swing.core.GenericTypeMatcher<T>

Type Parameters:

T - the type of Component supported by this matcher.

All Implemented Interfaces:

ComponentMatcher, ResettableComponentMatcher

Direct Known Subclasses:

NamedComponentMatcherTemplate

public abstract class GenericTypeMatcher<T extends Component>
extends AbstractComponentMatcher

ComponentMatcher that matches an AWT or Swing Component by type and some custom search criteria. It uses generics to improve type safety.

Author:

Yvonne Wang, Alex Ruiz

Constructor Summary

Constructors

Constructor and Description
GenericTypeMatcher(Class<T> supportedType) Creates a new GenericTypeMatcher.
GenericTypeMatcher(Class<T> supportedType, boolean requireShowing) Creates a new GenericTypeMatcher.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract boolean	isMatching(T component) Verifies that the given AWT or Swing Component matches some search criteria.
boolean	matches(Component c) Verifies that the given AWT or Swing Component: Is an instance of the generic type specified in this ComponentMatcher Matches some search criteria
Class<T>	supportedType()

Methods inherited from class org.assertj.swing.core.AbstractComponentMatcher

requireShowing, requireShowing, requireShowingMatches, reset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericTypeMatcher

public GenericTypeMatcher(@Nonnull
                  Class<T> supportedType)

Creates a new GenericTypeMatcher. The Component to match does not have to be showing.

Parameters:

supportedType - the type supported by this matcher.

Throws:

NullPointerException - if the given type is null.

GenericTypeMatcher

public GenericTypeMatcher(@Nonnull
                  Class<T> supportedType,
                  boolean requireShowing)

Creates a new GenericTypeMatcher.

Parameters:

supportedType - the type supported by this matcher.

requireShowing - indicates if the Component to match should be showing or not.

Throws:

NullPointerException - if the given type is null.

Method Detail

matches

@RunsInCurrentThread
public final boolean matches(@Nullable
                                  Component c)

Verifies that the given AWT or Swing Component:

1. Is an instance of the generic type specified in this ComponentMatcher
2. Matches some search criteria

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.

Parameters:

c - the Component to verify.

Returns:

true if the given Component is an instance of the generic type of this matcher and matches some search criteria. Otherwise, false.

supportedType

@Nonnull
public final Class<T> supportedType()

Returns:

the supported type of this matcher.

isMatching

@RunsInCurrentThread
protected abstract boolean isMatching(@Nonnull
                                     T component)

Verifies that the given AWT or Swing Component matches some search criteria.

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.

Parameters:

component - the Component to verify.

Returns:

true if the given Component matches the defined search criteria; otherwise, false .