org.assertj.swing.core.matcher

Class JTextComponentMatcher

java.lang.Object

org.assertj.swing.core.AbstractComponentMatcher

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

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

org.assertj.swing.core.matcher.JTextComponentMatcher

All Implemented Interfaces:

ComponentMatcher, ResettableComponentMatcher

public final class JTextComponentMatcher
extends NamedComponentMatcherTemplate<JTextComponent>

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

Author:

Alex Ruiz

Method Summary

Methods

Modifier and Type	Method and Description
JTextComponentMatcher	andShowing() Indicates that the JTextComponent to match should be showing on the screen.
JTextComponentMatcher	andText(Pattern textPattern) Specifies the text to match.
JTextComponentMatcher	andText(String newText) Specifies the text to match.
static JTextComponentMatcher	any() Creates a new JTextComponentMatcher that matches any JTextComponent.
protected boolean	isMatching(JTextComponent textComponent) Indicates whether the text of the given JTextComponent is equal to the text in this matcher.
String	toString()
static JTextComponentMatcher	withName(String name) Creates a new JTextComponentMatcher that matches a JTextComponent by name.
static JTextComponentMatcher	withText(Pattern textPattern) Creates a new JTextComponentMatcher that matches a JTextComponent by its text.
static JTextComponentMatcher	withText(String text) Creates a new JTextComponentMatcher that matches a JTextComponent 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 JTextComponentMatcher withName(@Nullable
                                     String name)

Creates a new JTextComponentMatcher that matches a JTextComponent by name.

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

 JTextComponentMatcher m = withName("lastName").andText("Wang");
 

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

 JTextComponentMatcher m = withName("lastName").andText("Wang").andShowing();
 

Parameters:

name - the id to match.

Returns:

the created matcher.

withText

@Nonnull
public static JTextComponentMatcher withText(@Nonnull
                                     String text)

Creates a new JTextComponentMatcher that matches a JTextComponent by text.

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

 JTextComponentMatcher m = withText("Wang");
 

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

 JTextComponentMatcher m = withText("Wang").andShowing();
 

Parameters:

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

Returns:

the created matcher.

withText

@Nonnull
public static JTextComponentMatcher withText(@Nonnull
                                     Pattern textPattern)

Creates a new JTextComponentMatcher that matches a JTextComponent by its text.

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

 JTextComponentMatcher m = withText(Pattern.compile("W.*"));
 

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

 JTextComponentMatcher m = withText(Pattern.compile("W.*")).andShowing();
 

Parameters:

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

Returns:

the created matcher.

any

@Nonnull
public static JTextComponentMatcher any()

Creates a new JTextComponentMatcher that matches any JTextComponent.

Returns:

the created matcher.

andText

@Nonnull
public JTextComponentMatcher andText(@Nonnull
                                    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

@Nonnull
public JTextComponentMatcher 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 JTextComponentMatcher andShowing()

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

Returns:

this matcher.

isMatching

@RunsInCurrentThread
protected boolean isMatching(@Nonnull
                                     JTextComponent textComponent)

Indicates whether the text of the given JTextComponent is equal to the text 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<JTextComponent>

Parameters:

textComponent - the JTextComponent to match.

Returns:

true if the text in the JTextComponent is equal to the text in this matcher, false otherwise.

toString

public String toString()

Overrides:

toString in class Object