org.assertj.swing.core.matcher

Class FrameMatcher

java.lang.Object

org.assertj.swing.core.AbstractComponentMatcher

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

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

org.assertj.swing.core.matcher.FrameMatcher

All Implemented Interfaces:

ComponentMatcher, ResettableComponentMatcher

public final class FrameMatcher
extends NamedComponentMatcherTemplate<Frame>

Matches AWT or Swing Frames by name, title or visibility on the screen.

Author:

Alex Ruiz

Method Summary

Methods

Modifier and Type	Method and Description
FrameMatcher	andShowing() Indicates that the AWT or Swing Frame to match should be showing on the screen.
FrameMatcher	andTitle(Pattern titlePattern) Specifies the title to match.
FrameMatcher	andTitle(String newTitle) Specifies the title to match.
static FrameMatcher	any() Creates a new FrameMatcher that matches any java.awt.Frame.
protected boolean	isMatching(Frame frame) Indicates whether the name and title of the given AWT or Swing Frame match the ones in this matcher.
String	toString()
static FrameMatcher	withName(String name) Creates a new FrameMatcher that matches an AWT or Swing Frame by name.
static FrameMatcher	withTitle(Pattern pattern) Creates a new FrameMatcher that matches an AWT or Swing Frame by title.
static FrameMatcher	withTitle(String title) Creates a new FrameMatcher that matches an AWT or Swing Frame by title.

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

public static FrameMatcher withName(@Nullable
                    String name)

Creates a new FrameMatcher that matches an AWT or Swing Frame by name.

The following code listing shows how to match a Frame by name and title:

 FrameMatcher m = withName("myApp").andTitle("My App");
 

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

 FrameMatcher m = withName("myApp").andTitle("My App").andShowing();
 

Parameters:

name - the id to match.

Returns:

the created matcher.

withTitle

public static FrameMatcher withTitle(@Nonnull
                     String title)

Creates a new FrameMatcher that matches an AWT or Swing Frame by title.

The following code listing shows how to match a Frame by title:

 FrameMatcher m = withTitle("My App");
 

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

 FrameMatcher m = withTitle("My App").andShowing();
 

Parameters:

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

Returns:

the created matcher.

withTitle

@Nonnull
public static FrameMatcher withTitle(@Nonnull
                             Pattern pattern)

Creates a new FrameMatcher that matches an AWT or Swing Frame by title.

The following code listing shows how to match a Frame by title, using a regular expression matcher:

 FrameMatcher m = withTitle(Pattern.compile("My.*"));
 

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

 FrameMatcher m = withTitle(Pattern.compile("My.*")).andShowing();
 

Parameters:

pattern - the title to match.

Returns:

the created matcher.

any

@Nonnull
public static FrameMatcher any()

Creates a new FrameMatcher that matches any java.awt.Frame.

Returns:

the created matcher.

andTitle

@Nonnull
public FrameMatcher andTitle(@Nonnull
                            String newTitle)

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

Parameters:

newTitle - the new title to match. It can be a regular expression.

Returns:

this matcher.

andTitle

@Nonnull
public FrameMatcher andTitle(@Nonnull
                            Pattern titlePattern)

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

Parameters:

titlePattern - the regular expression pattern to match.

Returns:

this matcher.

andShowing

@Nonnull
public FrameMatcher andShowing()

Indicates that the AWT or Swing Frame to match should be showing on the screen.

Returns:

this matcher.

isMatching

@RunsInCurrentThread
protected boolean isMatching(@Nonnull
                                     Frame frame)

Indicates whether the name and title of the given AWT or Swing Frame 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<Frame>

Parameters:

frame - the Frame to match.

Returns:

true if the title in the Frame is equal to the title in this matcher, false otherwise.

toString

public String toString()

Overrides:

toString in class Object