org.assertj.swing.core

Class NameMatcher

java.lang.Object

org.assertj.swing.core.AbstractComponentMatcher

org.assertj.swing.core.NameMatcher

All Implemented Interfaces:

ComponentMatcher, ResettableComponentMatcher

public final class NameMatcher
extends AbstractComponentMatcher

Matches an AWT or Swing Component by name and (optionally) by type.

Author:

Alex Ruiz

Constructor Summary

Constructors

Constructor and Description
NameMatcher(String name) Creates a new NameMatcher.
NameMatcher(String name, boolean requireShowing) Creates a new NameMatcher.
NameMatcher(String name, Class<? extends Component> type) Creates a new NameMatcher.
NameMatcher(String name, Class<? extends Component> type, boolean requireShowing) Creates a new NameMatcher.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(Component c) Indicates whether the name and visibility of the given AWT or Swing Component matches the value specified in this matcher.
String	toString()

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, wait, wait, wait

Constructor Detail

NameMatcher

public NameMatcher(@Nullable
           String name)

Creates a new NameMatcher. The AWT or Swing Component to match does not have to be showing.

Parameters:

name - the name of the Component we are looking for.

Throws:

NullPointerException - if the given name is null.

IllegalArgumentException - if the given name is empty.

NameMatcher

public NameMatcher(@Nullable
           String name,
           boolean requireShowing)

Creates a new NameMatcher.

Parameters:

name - the name of the AWT or Swing Component we are looking for.

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

Throws:

NullPointerException - if the given name is null.

IllegalArgumentException - if the given name is empty.

NameMatcher

public NameMatcher(@Nullable
           String name,
           @Nonnull
           Class<? extends Component> type)

Creates a new NameMatcher. The AWT or Swing Component to match does not have to be showing.

Parameters:

name - the name of the Component we are looking for.

type - the type of the Component we are looking for.

Throws:

NullPointerException - if the given name is empty.

IllegalArgumentException - if the given name is empty.

NullPointerException - if the given type is null.

NameMatcher

public NameMatcher(@Nullable
           String name,
           @Nonnull
           Class<? extends Component> type,
           boolean requireShowing)

Creates a new NameMatcher.

Parameters:

name - the name of the AWT or Swing Component we are looking for.

type - the type of the Component we are looking for.

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

Throws:

NullPointerException - if the given name is empty.

IllegalArgumentException - if the given name is empty.

NullPointerException - if the given type is null.

Method Detail

matches

@RunsInCurrentThread
public boolean matches(@Nullable
                                  Component c)

Indicates whether the name and visibility of the given AWT or Swing Component matches the value specified in this matcher.

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 name and visibility of the given Component matches the values specified in this matcher, false otherwise.

toString

public String toString()

Overrides:

toString in class Object