org.assertj.swing.format

Class ComponentFormatterTemplate

java.lang.Object

org.assertj.swing.format.ComponentFormatterTemplate

All Implemented Interfaces:

ComponentFormatter

Direct Known Subclasses:

IntrospectionComponentFormatter, JComboBoxFormatter, JFileChooserFormatter, JListFormatter, JOptionPaneFormatter, JTabbedPaneFormatter, JTableFormatter, JTreeFormatter

public abstract class ComponentFormatterTemplate
extends Object
implements ComponentFormatter

Template for implementations of ComponentFormatter.

Author:

Yvonne Wang

Constructor Summary

Constructors

Constructor and Description
ComponentFormatterTemplate()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	doFormat(Component c) Returns the String representation of the given AWT or Swing Component.
String	format(Component c) Returns the String representation of the given AWT or Swing Component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.assertj.swing.format.ComponentFormatter

targetType

Constructor Detail

ComponentFormatterTemplate

public ComponentFormatterTemplate()

Method Detail

format

@RunsInCurrentThread
@Nonnull
public final String format(@Nonnull
                                        Component c)

Returns the String representation of the given AWT or Swing Component.

Specified by:

format in interface ComponentFormatter

Parameters:

c - the given Component.

Returns:

the String representation of the given Component.

Throws:

NullPointerException - if the given Component is null.

IllegalArgumentException - if the type of the given Component is not supported by this formatter.

doFormat

@RunsInCurrentThread
@Nonnull
protected abstract String doFormat(@Nonnull
                                          Component c)

Returns the String representation of the given AWT or Swing Component.

Parameters:

c - the given Component.

Returns:

the String representation of the given Component.