org.assertj.swing.core

Class ComponentFoundCondition

java.lang.Object

org.assertj.swing.timing.Condition

org.assertj.swing.core.ComponentFoundCondition

public final class ComponentFoundCondition
extends Condition

Condition that is satisfied if an AWT or Swing Component that matches certain search criteria is found.

Author:

Yvonne Wang, Alex Ruiz

Field Summary

Fields inherited from class org.assertj.swing.timing.Condition

EMPTY_TEXT

Constructor Summary

Constructors

Constructor and Description
ComponentFoundCondition(org.assertj.core.description.Description description, ComponentFinder finder, ComponentMatcher matcher) Creates a new ComponentFoundCondition.
ComponentFoundCondition(org.assertj.core.description.Description description, ComponentFinder finder, ComponentMatcher matcher, Container root) Creates a new ComponentFoundCondition.
ComponentFoundCondition(String description, ComponentFinder finder, ComponentMatcher matcher) Creates a new ComponentFoundCondition.
ComponentFoundCondition(String description, ComponentFinder finder, ComponentMatcher matcher, Container root) Creates a new ComponentFoundCondition.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	descriptionAddendum() Returns any text to be added to this condition's description.
Collection<Component>	duplicatesFound()
Component	found()
boolean	test() Indicates whether true an AWT or Swing Component, that matches the search criteria in this condition's ComponentMatcher, can be found.

Methods inherited from class org.assertj.swing.timing.Condition

done, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentFoundCondition

public ComponentFoundCondition(@Nonnull
                       String description,
                       @Nonnull
                       ComponentFinder finder,
                       @Nonnull
                       ComponentMatcher matcher)

Creates a new ComponentFoundCondition.

Parameters:

description - the description of this condition.

finder - performs the search.

matcher - specifies the condition that the AWT or Swing Component we are looking for needs to match.

ComponentFoundCondition

public ComponentFoundCondition(@Nonnull
                       String description,
                       @Nonnull
                       ComponentFinder finder,
                       @Nonnull
                       ComponentMatcher matcher,
                       @Nullable
                       Container root)

Creates a new ComponentFoundCondition.

Parameters:

description - the description of this condition.

finder - performs the search.

matcher - specifies the condition that the AWT or Swing Component we are looking for needs to match.

root - the root Container used as the starting point of the search.

ComponentFoundCondition

public ComponentFoundCondition(@Nonnull
                       org.assertj.core.description.Description description,
                       @Nonnull
                       ComponentFinder finder,
                       @Nonnull
                       ComponentMatcher matcher)

Creates a new ComponentFoundCondition.

Parameters:

description - the description of this condition.

finder - performs the search.

matcher - specifies the condition that the AWT or Swing Component we are looking for needs to match.

ComponentFoundCondition

public ComponentFoundCondition(@Nonnull
                       org.assertj.core.description.Description description,
                       @Nonnull
                       ComponentFinder finder,
                       @Nonnull
                       ComponentMatcher matcher,
                       @Nullable
                       Container root)

Creates a new ComponentFoundCondition.

Parameters:

description - the description of this condition.

finder - performs the search.

matcher - specifies the condition that the AWT or Swing Component we are looking for needs to match.

root - the root Container used as the starting point of the search.

Method Detail

test

public boolean test()

Indicates whether true an AWT or Swing Component, that matches the search criteria in this condition's ComponentMatcher, can be found.

Specified by:

test in class Condition

Returns:

true if a matching Component can be found, false otherwise.

descriptionAddendum

@Nonnull
protected String descriptionAddendum()

Description copied from class: Condition

Returns any text to be added to this condition's description. The default value is an empty String.

Overrides:

descriptionAddendum in class Condition

Returns:

the AWT Component hierarchy to be added to this condition's description in case of a lookup failure.

found

@Nullable
public Component found()

Returns:

the AWT or Swing Component found.

duplicatesFound

public Collection<Component> duplicatesFound()

Returns:

all the AWT or Swing Components that satisfied the search criteria specified by this condition's ComponentMatcher.