org.assertj.swing.core.matcher

Class DialogMatcher

java.lang.Object

org.assertj.swing.core.AbstractComponentMatcher

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

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

org.assertj.swing.core.matcher.DialogMatcher

All Implemented Interfaces:

ComponentMatcher, ResettableComponentMatcher

public final class DialogMatcher
extends NamedComponentMatcherTemplate<Dialog>

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

Author:

Alex Ruiz

Method Summary

Methods

Modifier and Type	Method and Description
DialogMatcher	andShowing() Indicates that the AWT or Swing Dialog to match should be showing on the screen.
DialogMatcher	andTitle(Pattern titlePattern) Specifies the title to match.
DialogMatcher	andTitle(String newTitle) Specifies the title to match.
static DialogMatcher	any() Creates a new DialogMatcher that matches any Dialog.
protected boolean	isMatching(Dialog dialog) Indicates whether the name and title of the given AWT or Swing Dialog match the ones in this matcher.
String	toString()
static DialogMatcher	withName(String name) Creates a new DialogMatcher that matches an AWT or Swing Dialog by name.
static DialogMatcher	withTitle(Pattern pattern) Creates a new DialogMatcher that matches an AWT or Swing Dialog by title.
static DialogMatcher	withTitle(String title) Creates a new DialogMatcher that matches an AWT or Swing Dialog 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 DialogMatcher withName(@Nullable
                     String name)

Creates a new DialogMatcher that matches an AWT or Swing Dialog by name.

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

 DialogMatcher m = withName("saveFile").andTitle("Save File");
 

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

 DialogMatcher m = withName("saveFile").andTitle("Save File").andShowing();
 

Parameters:

name - the id to match.

Returns:

the created matcher.

withTitle

@Nonnull
public static DialogMatcher withTitle(@Nullable
                              String title)

Creates a new DialogMatcher that matches an AWT or Swing Dialog by title.

The following code listing shows how to match a Dialog title:

 DialogMatcher m = withTitle("Save File");
 

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

 DialogMatcher m = withTitle("Save File").andShowing();
 

Parameters:

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

Returns:

the created matcher.

withTitle

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

Creates a new DialogMatcher that matches an AWT or Swing Dialog by title.

The following code listing shows how to match a Dialog title, using a regular expression pattern:

 DialogMatcher m = withTitle(Pattern.compile("Sav.*"));
 

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

 DialogMatcher m = withTitle(Pattern.compile("Sav.*")).andShowing();
 

Parameters:

pattern - the regular expression pattern to match.

Returns:

the created matcher.

any

@Nonnull
public static DialogMatcher any()

Creates a new DialogMatcher that matches any Dialog.

Returns:

the created matcher.

andTitle

@Nonnull
public DialogMatcher andTitle(@Nullable
                             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

public DialogMatcher 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 DialogMatcher andShowing()

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

Returns:

this matcher.

isMatching

@RunsInCurrentThread
protected boolean isMatching(@Nonnull
                                     Dialog dialog)

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

Parameters:

dialog - the Dialog to match.

Returns:

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

toString

public String toString()

Overrides:

toString in class Object