org.assertj.swing.finder

Class FrameFinder

java.lang.Object

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

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

org.assertj.swing.finder.FrameFinder

public class FrameFinder
extends WindowFinderTemplate<Frame>

Finder for Frames. This class cannot be used directly, please see WindowFinder.

Author:

Alex Ruiz, Yvonne Wang

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FrameFinder(Class<? extends Frame> frameType) Creates a new FrameFinder.
protected	FrameFinder(GenericTypeMatcher<? extends Frame> matcher) Creates a new FrameFinder.
protected	FrameFinder(String frameName) Creates a new FrameFinder.

Method Summary

Methods

Modifier and Type	Method and Description
protected Frame	cast(Component c) Casts the given AWT or Swing Component to Frame.
FrameFixture	using(Robot robot) Finds a Frame by name or type.
FrameFinder	withTimeout(long timeout) Sets the timeout for this finder.
FrameFinder	withTimeout(long timeout, TimeUnit unit) Sets the timeout for this finder.

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

findComponentWith

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameFinder

protected FrameFinder(@Nullable
           String frameName)

Creates a new FrameFinder.

Parameters:

frameName - the name of the Frame to look for.

FrameFinder

protected FrameFinder(@Nonnull
           GenericTypeMatcher<? extends Frame> matcher)

Creates a new FrameFinder.

Parameters:

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

FrameFinder

protected FrameFinder(@Nonnull
           Class<? extends Frame> frameType)

Creates a new FrameFinder.

Parameters:

frameType - the type of Frame to look for.

Method Detail

withTimeout

@Nonnull
public FrameFinder withTimeout(@Nonnegative
                              long timeout)

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

Overrides:

withTimeout in class WindowFinderTemplate<Frame>

Parameters:

timeout - the number of milliseconds before stopping the search.

Returns:

this finder.

withTimeout

@Nonnull
public FrameFinder withTimeout(@Nonnegative
                              long timeout,
                              @Nonnull
                              TimeUnit unit)

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

Overrides:

withTimeout in class WindowFinderTemplate<Frame>

Parameters:

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

unit - the time unit for timeout.

Returns:

this finder.

using

@Nonnull
public FrameFixture using(@Nonnull
                         Robot robot)

Finds a Frame by name or type.

Specified by:

using in class WindowFinderTemplate<Frame>

Parameters:

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

Returns:

a FrameFixture managing the found Frame.

Throws:

WaitTimedOutError - if a Frame could not be found.

cast

@Nullable
protected Frame cast(@Nullable
                  Component c)

Casts the given AWT or Swing Component to Frame.

Specified by:

cast in class ComponentFinderTemplate<Frame>

Parameters:

c - the given Component.

Returns:

the given Component, casted to Frame.