org.assertj.swing.core.matcher

Class NamedComponentMatcherTemplate<T extends Component>

java.lang.Object

org.assertj.swing.core.AbstractComponentMatcher

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

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

Type Parameters:

T - the type of Component supported by this matcher.

All Implemented Interfaces:

ComponentMatcher, ResettableComponentMatcher

Direct Known Subclasses:

DialogMatcher, FrameMatcher, JButtonMatcher, JLabelMatcher, JTextComponentMatcher

public abstract class NamedComponentMatcherTemplate<T extends Component>
extends GenericTypeMatcher<T>

Template for matching AWT or Swing Component by name. Subclasses are free to add other properties to use as search criteria.

Author:

Alex Ruiz

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NamedComponentMatcherTemplate(Class<T> supportedType) Creates a new NamedComponentMatcherTemplate.
protected	NamedComponentMatcherTemplate(Class<T> supportedType, Object name) Creates a new NamedComponentMatcherTemplate.

Method Summary

Methods

Modifier and Type	Method and Description
protected static Object	anyValue()
protected boolean	arePropertyValuesMatching(Object expected, Object actual) Indicates whether the given value matches the expected value in this matcher.
protected boolean	isNameMatching(String actual) Indicates whether the given value matches the name in this matcher.
protected Object	name()
protected Object	quoted(Object propertyValue) Returns the given property value to match surrounded by double quotes.
protected Object	quotedName() Returns the name to match surrounded by double quotes.

Methods inherited from class org.assertj.swing.core.GenericTypeMatcher

isMatching, 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, toString, wait, wait, wait

Constructor Detail

NamedComponentMatcherTemplate

protected NamedComponentMatcherTemplate(@Nonnull
                             Class<T> supportedType)

Creates a new NamedComponentMatcherTemplate.

Parameters:

supportedType - the type supported by this matcher.

Throws:

NullPointerException - if the given type is null.

NamedComponentMatcherTemplate

protected NamedComponentMatcherTemplate(@Nonnull
                             Class<T> supportedType,
                             @Nullable
                             Object name)

Creates a new NamedComponentMatcherTemplate.

Parameters:

supportedType - the type supported by this matcher.

name - the name to match.

Throws:

NullPointerException - if the given type is null.

Method Detail

quotedName

@Nullable
protected final Object quotedName()

Returns the name to match surrounded by double quotes. If the name to match has not been set, it will return anyValue(). This method is commonly used in implementations of toString.

Returns:

the component name to match surrounded by double quotes, or anyValue() if the name to match has not been set.

quoted

@Nullable
protected final Object quoted(@Nullable
                     Object propertyValue)

Returns the given property value to match surrounded by double quotes. If the property has not been set, it will return anyValue(). This method is commonly used in implementations of toString.

Parameters:

propertyValue - the given property value.

Returns:

the given property value to match surrounded by double quotes, or anyValue() if the property value has not been set.

isNameMatching

protected final boolean isNameMatching(@Nullable
                     String actual)

Indicates whether the given value matches the name in this matcher. It always returns true if this matcher's name is anyValue().

Parameters:

actual - the actual name of an AWT or Swing Component.

Returns:

true if this matcher's name is ANY or if both the actual name is equal to the one in this matcher. Otherwise false.

arePropertyValuesMatching

protected final boolean arePropertyValuesMatching(@Nullable
                                Object expected,
                                @Nullable
                                Object actual)

Indicates whether the given value matches the expected value in this matcher. Matching is performed as follows:

1. it always returns true if the expected value is anyValue()
2. if both the expected and actual values are Strings, it checks for equality first. If this fails, it tries to match the values assuming the expected value can be a regular expression
3. if the expected value is a Pattern and the actual value is a CharSequence, regular expression matching is performed
4. otherwise, it checks that both the expected and actual values are equal

Parameters:

expected - the expected value in this matcher.

actual - the actual property value.

Returns:

true if the values match, otherwise false.

name

@Nullable
protected final Object name()

anyValue

@Nonnull
protected static final Object anyValue()