org.assertj.swing.core.matcher

Class JButtonMatcher

java.lang.Object

org.assertj.swing.core.AbstractComponentMatcher

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

org.assertj.swing.core.matcher.NamedComponentMatcherTemplate<JButton>

org.assertj.swing.core.matcher.JButtonMatcher

All Implemented Interfaces:

ComponentMatcher, ResettableComponentMatcher

public final class JButtonMatcher
extends NamedComponentMatcherTemplate<JButton>

Matches JButtons by name, text or visibility on the screen.

Author:

Alex Ruiz

Method Summary

Methods

Modifier and Type	Method and Description
JButtonMatcher	andShowing() Indicates that the JButton to match should be showing on the screen.
JButtonMatcher	andText(Pattern textPattern) Specifies the text to match.
JButtonMatcher	andText(String newText) Specifies the text to match.
static JButtonMatcher	any() Creates a new JButtonMatcher that matches any JButton.
protected boolean	isMatching(JButton button) Indicates whether the name and text of the given JButton match the ones in this matcher.
String	toString()
static JButtonMatcher	withName(String name) Creates a new JButtonMatcher that matches a JButton by name:
static JButtonMatcher	withText(Pattern pattern) Creates a new JButtonMatcher that matches a JButton by text.
static JButtonMatcher	withText(String text) Creates a new JButtonMatcher that matches a JButton by text.

Methods inherited from class org.assertj.swing.core.matcher.NamedComponentMatcherTemplate

anyValue, arePropertyValuesMatching, isNameMatching, name, quoted, quotedName

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

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

Method Detail

withName

@Nonnull
public static JButtonMatcher withName(@Nullable
                              String name)

Creates a new JButtonMatcher that matches a JButton by name:

The following code listing shows how to match a JButton by name and text:

 JButtonMatcher m = withName("ok").andText("OK");
 

The following code listing shows how to match a JButton, that should be showing on the screen, by name and text:

 JButtonMatcher m = withName("ok").andText("OK").andShowing();
 

Parameters:

name - the name to match.

Returns:

the created matcher.

withText

@Nonnull
public static JButtonMatcher withText(@Nullable
                              String text)

Creates a new JButtonMatcher that matches a JButton by text.

The following code listing shows how to match a JButton by text:

 JButtonMatcher m = withText("OK");
 

The following code listing shows how to match a JButton, that should be showing on the screen, by text:

 JButtonMatcher m = withText("OK").andShowing();
 

Parameters:

text - the text to match. It can be a regular expression.

Returns:

the created matcher.

withText

@Nonnull
public static JButtonMatcher withText(@Nonnull
                              Pattern pattern)

Creates a new JButtonMatcher that matches a JButton by text.

The following code listing shows how to match a JButton by text, using a regular expression pattern:

 JButtonMatcher m = withText(Pattern.compile("O.*"));
 

The following code listing shows how to match a JButton, that should be showing on the screen, by text, using a regular expression pattern:

 JButtonMatcher m = withText(Pattern.compile("O.*")).andShowing();
 

Parameters:

pattern - the regular expression pattern to match.

Returns:

the created matcher.

any

public static JButtonMatcher any()

Creates a new JButtonMatcher that matches any JButton.

Returns:

the created matcher.

andText

@Nonnull
public JButtonMatcher andText(@Nullable
                             String newText)

Specifies the text to match. If this matcher was created using withText(String) or withText(Pattern), this method will simply update the text to match.

Parameters:

newText - the new text to match. It can be a regular expression.

Returns:

this matcher.

andText

public JButtonMatcher andText(@Nonnull
                     Pattern textPattern)

Specifies the text to match. If this matcher was created using withText(String) or withText(Pattern), this method will simply update the text to match.

Parameters:

textPattern - the regular expression pattern to match.

Returns:

this matcher.

andShowing

@Nonnull
public JButtonMatcher andShowing()

Indicates that the JButton to match should be showing on the screen.

Returns:

this matcher.

isMatching

@RunsInCurrentThread
protected boolean isMatching(@Nonnull
                                     JButton button)

Indicates whether the name and text of the given JButton match the ones 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.

Specified by:

isMatching in class GenericTypeMatcher<JButton>

Parameters:

button - the JButton to match.

Returns:

true if the JButton matches the search criteria in this matcher.

toString

public String toString()

Overrides:

toString in class Object