org.assertj.swing.finder

Class WindowFinderTemplate<T extends Window>

java.lang.Object

org.assertj.swing.finder.ComponentFinderTemplate<T>

org.assertj.swing.finder.WindowFinderTemplate<T>

Type Parameters:

T - the type of Window this finder can search.

Direct Known Subclasses:

DialogFinder, FrameFinder

public abstract class WindowFinderTemplate<T extends Window>
extends ComponentFinderTemplate<T>

Template for Window finders.

Author:

Yvonne Wang, Alex Ruiz

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WindowFinderTemplate(Class<? extends T> windowType) Creates a new WindowFinderTemplate.
protected	WindowFinderTemplate(GenericTypeMatcher<? extends T> matcher) Creates a new WindowFinderTemplate.
protected	WindowFinderTemplate(String windowName, Class<? extends T> windowType) Creates a new WindowFinderTemplate.

Method Summary

Methods

Modifier and Type	Method and Description
abstract AbstractWindowFixture<?,T,?>	using(Robot robot) Finds a Window by name or type using the given robot.
protected WindowFinderTemplate<T>	withTimeout(long timeout) Sets the timeout for this finder.
protected WindowFinderTemplate<T>	withTimeout(long timeout, TimeUnit unit) Sets the timeout for this finder.

Methods inherited from class org.assertj.swing.finder.ComponentFinderTemplate

cast, findComponentWith

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WindowFinderTemplate

protected WindowFinderTemplate(@Nullable
                    String windowName,
                    @Nonnull
                    Class<? extends T> windowType)

Creates a new WindowFinderTemplate.

Parameters:

windowName - the name of the Window to find.

windowType - the type of the Window to find.

WindowFinderTemplate

protected WindowFinderTemplate(@Nonnull
                    GenericTypeMatcher<? extends T> matcher)

Creates a new WindowFinderTemplate.

Parameters:

matcher - specifies the search criteria to use when looking up a Window.

WindowFinderTemplate

protected WindowFinderTemplate(@Nonnull
                    Class<? extends T> windowType)

Creates a new WindowFinderTemplate.

Parameters:

windowType - the type of the Window to find.

Method Detail

withTimeout

@Nonnull
protected WindowFinderTemplate<T> withTimeout(@Nonnegative
                                          long timeout)

Sets the timeout for this finder. The Window to find should be found within the given time period.

Overrides:

withTimeout in class ComponentFinderTemplate<T extends Window>

Parameters:

timeout - the number of milliseconds before stopping the search.

Returns:

this finder.

Throws:

IllegalArgumentException - if the timeout is a negative number.

withTimeout

protected WindowFinderTemplate<T> withTimeout(@Nonnegative
                                  long timeout,
                                  @Nonnull
                                  TimeUnit unit)

Sets the timeout for this finder. The Window to find should be found within the given time period.

Overrides:

withTimeout in class ComponentFinderTemplate<T extends Window>

Parameters:

timeout - the period of time the search should be performed.

unit - the time unit for timeout.

Returns:

this finder.

Throws:

NullPointerException - if the time unit is null.

IllegalArgumentException - if the timeout is a negative number.

using

@Nonnull
public abstract AbstractWindowFixture<?,T,?> using(@Nonnull
                                         Robot robot)

Finds a Window by name or type using the given robot.

Specified by:

using in class ComponentFinderTemplate<T extends Window>

Parameters:

robot - contains the underlying finding to delegate the search to.

Returns:

a fixture capable of managing the found Window.

Throws:

WaitTimedOutError - if a Window with the given name or of the given type could not be found.