org.assertj.swing.core.matcher

Class JLabelMatcher

java.lang.Object

org.assertj.swing.core.AbstractComponentMatcher

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

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

org.assertj.swing.core.matcher.JLabelMatcher

All Implemented Interfaces:

ComponentMatcher, ResettableComponentMatcher

public final class JLabelMatcher
extends NamedComponentMatcherTemplate<JLabel>

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

Author:

Alex Ruiz

Method Summary

Methods

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

Creates a new JLabelMatcher that matches a JLabel by text.

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

 JLabelMatcher m = withName("firstName").andText("First Name:");
 

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

 JLabelMatcher m = withName("firstName").andText("First Name:").andShowing();
 

Parameters:

name - the id to match.

Returns:

the created matcher.

withText

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

Creates a new JLabelMatcher that matches a JLabel by text.

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

 JLabelMatcher m = withText("First Name:");
 

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

 JLabelMatcher m = withText("First Name:").andShowing();
 

Parameters:

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

Returns:

the created matcher.

withText

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

Creates a new JLabelMatcher that matches a JLabel by text.

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

 JLabelMatcher m = withText(Pattern.compile("F.*");
 

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

 JLabelMatcher m = withText(Pattern.compile("F.*").andShowing();
 

Parameters:

textPattern - the regular expression pattern to match.

Returns:

the created matcher.

any

@Nonnull
public static JLabelMatcher any()

Creates a new JLabelMatcher that matches any JLabel.

Returns:

the created matcher.

andText

@Nonnull
public JLabelMatcher 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

@Nonnull
public JLabelMatcher 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

public JLabelMatcher andShowing()

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

Returns:

this matcher.

isMatching

@RunsInCurrentThread
protected boolean isMatching(@Nonnull
                                     JLabel label)

Indicates whether the name and text of the given JLabel 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<JLabel>

Parameters:

label - the JLabel to match.

Returns:

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

toString

public String toString()

Overrides:

toString in class Object