org.assertj.swing.core

Class LabelMatcher

java.lang.Object

org.assertj.swing.core.AbstractComponentMatcher

org.assertj.swing.core.LabelMatcher

All Implemented Interfaces:

ComponentMatcher, ResettableComponentMatcher

public class LabelMatcher
extends AbstractComponentMatcher

Matches an AWT or Swing Component by the text of the associated JLabel and (optionally) by type.

Author:

Alex Ruiz

See Also:

JLabel.getLabelFor(), JLabel.setLabelFor(Component)

Constructor Summary

Constructors

Constructor and Description
LabelMatcher(String label) Creates a new LabelMatcher.
LabelMatcher(String label, boolean requireShowing) Creates a new LabelMatcher.
LabelMatcher(String label, Class<? extends Component> type) Creates a new LabelMatcher.
LabelMatcher(String label, Class<? extends Component> type, boolean requireShowing) Creates a new LabelMatcher.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(Component c) Indicates whether the given AWT or Swing Component matches the criteria specified in this matcher: the text of the JLabel attached to the Component to look for matches the text specified in this matcher the Component to look for is of the type specified in this matcher (if specified) visibility of the given Component matches the value specified in this matcher
String	toString()

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

Constructor Detail

LabelMatcher

public LabelMatcher(@Nullable
            String label)

Creates a new LabelMatcher. The AWT or Swing Component to match does not have to be showing.

Parameters:

label - the text of the label associated to the Component we are looking for.

Throws:

NullPointerException - if the given label is null.

IllegalArgumentException - if the given label is empty.

LabelMatcher

public LabelMatcher(@Nullable
            String label,
            boolean requireShowing)

Creates a new LabelMatcher.

Parameters:

label - the text of the label associated to the AWT or Swing Component we are looking for.

requireShowing - indicates if the Component to match should be showing or not.

Throws:

NullPointerException - if the given label is null.

IllegalArgumentException - if the given label is empty.

LabelMatcher

public LabelMatcher(@Nullable
            String label,
            @Nonnull
            Class<? extends Component> type)

Creates a new LabelMatcher. The AWT or Swing Component to match does not have to be showing.

Parameters:

label - the text of the label associated to the Component we are looking for.

type - the type of the Component we are looking for.

Throws:

NullPointerException - if the given label is null.

IllegalArgumentException - if the given label is empty.

NullPointerException - if the given type is null.

LabelMatcher

public LabelMatcher(@Nullable
            String label,
            @Nonnull
            Class<? extends Component> type,
            boolean requireShowing)

Creates a new LabelMatcher.

Parameters:

label - the text of the label associated to the AWT or Swing Component we are looking for.

type - the type of the Component we are looking for.

requireShowing - indicates if the Component to match should be showing or not.

Throws:

NullPointerException - if the given label is null.

IllegalArgumentException - if the given label is empty.

NullPointerException - if the given type is null.

Method Detail

matches

@RunsInCurrentThread
public boolean matches(@Nullable
                                  Component c)

Indicates whether the given AWT or Swing Component matches the criteria specified in this matcher:

1. the text of the JLabel attached to the Component to look for matches the text specified in this matcher
2. the Component to look for is of the type specified in this matcher (if specified)
3. visibility of the given Component matches the value specified 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.

Parameters:

c - the Component to verify.

Returns:

true if the name and visibility of the given Component matches the values specified in this matcher, false otherwise.

toString

public String toString()

Overrides:

toString in class Object