org.assertj.swing.core

Interface ComponentPrinter

All Known Implementing Classes:

BasicComponentPrinter

public interface ComponentPrinter

Sends the String representation of AWT and Swing Components to a java.io.PrintStream, to facilitate debugging.

Author:

Alex Ruiz

Method Summary

Methods

Modifier and Type	Method and Description
void	printComponents(PrintStream out) Prints all the AWT and Swing Components in the hierarchy.
void	printComponents(PrintStream out, Class<? extends Component> type) Prints only the AWT and Swing Components of the given type in the hierarchy.
void	printComponents(PrintStream out, Class<? extends Component> type, Container root) Prints all the AWT and Swing Components of the given type in the hierarchy under the given root.
void	printComponents(PrintStream out, ComponentMatcher matcher) Prints only the AWT and Swing Components that match the given search criteria in the hierarchy.
void	printComponents(PrintStream out, ComponentMatcher matcher, Container root) Prints all the AWT and Swing Components that match the given search criteria under the given root.
void	printComponents(PrintStream out, Container root) Prints all the AWT and Swing Components in the hierarchy under the given root.

Method Detail

printComponents

void printComponents(@Nonnull
                   PrintStream out)

Prints all the AWT and Swing Components in the hierarchy.

Parameters:

out - the output stream where to print the Components to.

Throws:

NullPointerException - if the output stream is null.

See Also:

Formatting.format(Component)

printComponents

void printComponents(@Nonnull
                   PrintStream out,
                   @Nullable
                   Container root)

Prints all the AWT and Swing Components in the hierarchy under the given root.

Parameters:

out - the output stream where to print the Components to.

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

Throws:

NullPointerException - if the output stream is null.

See Also:

Formatting.format(Component)

printComponents

void printComponents(@Nonnull
                   PrintStream out,
                   @Nonnull
                   Class<? extends Component> type)

Prints only the AWT and Swing Components of the given type in the hierarchy.

Parameters:

out - the output stream where to print the Components to.

type - the type of Components to print.

Throws:

NullPointerException - if the output stream is null.

NullPointerException - if type is null.

See Also:

Formatting.format(Component)

printComponents

void printComponents(@Nonnull
                   PrintStream out,
                   @Nonnull
                   Class<? extends Component> type,
                   @Nullable
                   Container root)

Prints all the AWT and Swing Components of the given type in the hierarchy under the given root.

Parameters:

out - the output stream where to print the Components to.

type - the type of Components to print.

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

Throws:

NullPointerException - if the output stream is null.

NullPointerException - if type is null.

See Also:

Formatting.format(Component)

printComponents

void printComponents(@Nonnull
                   PrintStream out,
                   @Nonnull
                   ComponentMatcher matcher)

Prints only the AWT and Swing Components that match the given search criteria in the hierarchy.

Parameters:

out - the output stream where to print the Components to.

matcher - specifies the search criteria to use filter the Components to print.

Throws:

NullPointerException - if the output stream is null.

NullPointerException - if matcher is null.

See Also:

Formatting.format(Component)

printComponents

void printComponents(@Nonnull
                   PrintStream out,
                   @Nonnull
                   ComponentMatcher matcher,
                   @Nullable
                   Container root)

Prints all the AWT and Swing Components that match the given search criteria under the given root.

Parameters:

out - the output stream where to print the Components to.

matcher - specifies the search criteria to use filter the Components to print.

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

Throws:

NullPointerException - if the output stream is null.

NullPointerException - if matcher is null.

See Also:

Formatting.format(Component)