edu.cnu.cs.gooey

Class Gooey

java.lang.Object

edu.cnu.cs.gooey.Gooey

public class Gooey
extends java.lang.Object

Title: Gooey

Description: Gooey is a jUnit Swing test library of static methods for capturing windows and retrieving their components.
Methods in this class are designed to be called in JUnit tests. There are methods to capture displayed windows/dialogs and query their components. Once a window is captured, methods can retrieve any component by type, by name, and (in the case of buttons, menus, tabs and labels) by displayed text.

See Also:

interface to access a captured window.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Gooey.Match Enumerated type indicating whether a component is sought by name or displayed text.

Method Summary

Modifier and Type	Method and Description
static <T extends GooeyDisplayable<U>,U extends java.awt.Window> void	capture(T displayable) This method uses a capture mechanism, which invokes the method displaying a window, waits for the window to display (within a timeout period) and calls the method to test this window.
static javax.swing.JButton	getButton(java.awt.Container container, java.lang.String text) Given a container it returns the button displaying the given text.
static javax.swing.JButton	getButton(java.awt.Container container, java.lang.String string, Gooey.Match flag) Given a container it returns the button associated with the given string.
static <T extends java.awt.Component> T	getComponent(java.awt.Container container, java.lang.Class<T> type) Returns the first component of a class found in a container.
static <T extends java.awt.Component> T	getComponent(java.awt.Container container, java.lang.Class<T> type, java.lang.String name) Returns a component found in the container that matches the given class type and associated name.
static <T extends java.awt.Component> java.util.List<T>	getComponents(java.awt.Container container, java.lang.Class<T> type) Returns a list with all components of a given class found in a container.
static <T extends java.awt.Component> java.util.List<T>	getComponents(java.awt.Container container, java.lang.Class<T> type, java.util.function.Predicate<T> criteria) Returns a list with all components of a given class found in a container that match the given criteria.
static javax.swing.JLabel	getLabel(java.awt.Container container, java.lang.String text) Given a container it returns the label displaying the given text.
static javax.swing.JLabel	getLabel(java.awt.Container container, java.lang.String string, Gooey.Match flag) Given a container it returns the label associated with the given string.
static javax.swing.JMenu	getMenu(javax.swing.JMenuBar menubar, java.lang.String text) Given a menu bar it returns the menu displaying the given text.
static javax.swing.JMenu	getMenu(javax.swing.JMenuBar menubar, java.lang.String string, Gooey.Match flag) Given a menu bar it returns the menu associated with the given string.
static <T extends javax.swing.JMenuItem> T	getMenu(javax.swing.JMenu menu, java.lang.String text) Given a menu it returns the sub-menu (i.e., another menu or a menu item) displaying the given text.
static <T extends javax.swing.JMenuItem> T	getMenu(javax.swing.JMenu menu, java.lang.String string, Gooey.Match flag) Given a menu it returns the sub-menu (i.e., another menu or a menu item) associated with the given string.
static javax.swing.JMenuBar	getMenuBar(javax.swing.JFrame frame) Returns the menu bar associated with a frame.
static java.util.List<javax.swing.JMenuItem>	getMenus(javax.swing.JMenu menu) Returns a list with all sub-menus (i.e., another menu or a menu item) in the menu provided.
static java.util.List<javax.swing.JMenu>	getMenus(javax.swing.JMenuBar menubar) Returns a list with top-level menus in the menu bar.
static java.awt.Component	getTab(javax.swing.JTabbedPane tabPane, java.lang.String title) Given a tab pane it returns the tab component with the given title.
static java.awt.Component	getTab(javax.swing.JTabbedPane tabPane, java.lang.String string, Gooey.Match flag) Given a tab pane it returns the component associated with the given string.
static java.lang.String	getVersion() Returns Gooey's current version number.
static void	main(java.lang.String[] args)

Methods inherited from class java.lang.Object

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

Method Detail

main

public static void main(java.lang.String[] args)

getVersion

public static final java.lang.String getVersion()

Returns Gooey's current version number. Intended to prevent that older versions are used in current projects.

Returns:

current build version number.

getTab

public static java.awt.Component getTab(javax.swing.JTabbedPane tabPane,
                                        java.lang.String title)

Given a tab pane it returns the tab component with the given title.

Parameters:

tabPane - pane holding the tab.

title - title of the tab sought.

Returns:

component found.

Throws:

java.lang.AssertionError - if no tab with the given title is found.

getTab

public static java.awt.Component getTab(javax.swing.JTabbedPane tabPane,
                                        java.lang.String string,
                                        Gooey.Match flag)

Given a tab pane it returns the component associated with the given string. The string acts as an identifier for the tab depending on the flag used. The flag indicates whether we're seeking tabs by title or by name.

Parameters:

tabPane - pane holding the tab.

string - identifier of the tab sought.

flag - to search by title (By_Text) or by name.

Returns:

component found.

Throws:

java.lang.AssertionError - if no tab with the given string is found.

getLabel

public static javax.swing.JLabel getLabel(java.awt.Container container,
                                          java.lang.String text)

Given a container it returns the label displaying the given text.

Parameters:

container - container holding the label.

text - text of the label sought.

Returns:

label found.

Throws:

java.lang.AssertionError - if no label with the given text is found.

getLabel

public static javax.swing.JLabel getLabel(java.awt.Container container,
                                          java.lang.String string,
                                          Gooey.Match flag)

Given a container it returns the label associated with the given string. The string acts as an identifier for the label depending on the flag used. The flag indicates whether we're seeking labels by text or by name.

Parameters:

container - container holding the label.

string - identifier of the label sought.

flag - to search by text or by name.

Returns:

label found.

Throws:

java.lang.AssertionError - if no label with the given string is found.

getButton

public static javax.swing.JButton getButton(java.awt.Container container,
                                            java.lang.String text)

Given a container it returns the button displaying the given text.

Parameters:

container - container holding the button.

text - text of the button sought.

Returns:

button found.

Throws:

java.lang.AssertionError - if no button with the given text is found.

getButton

public static javax.swing.JButton getButton(java.awt.Container container,
                                            java.lang.String string,
                                            Gooey.Match flag)

Given a container it returns the button associated with the given string. The string acts as an identifier for the button depending on the flag used. The flag indicates whether we're seeking buttons by text or by name.

Parameters:

container - container holding the button.

string - identifier of the button sought.

flag - to search by text or by name.

Returns:

button found.

Throws:

java.lang.AssertionError - if no button with the given string is found.

getMenuBar

public static javax.swing.JMenuBar getMenuBar(javax.swing.JFrame frame)

Returns the menu bar associated with a frame.

Parameters:

frame - the frame whose menu is requested.

Returns:

the frame's menu bar.

Throws:

java.lang.AssertionError - if no menu bar is found.

getMenu

public static javax.swing.JMenu getMenu(javax.swing.JMenuBar menubar,
                                        java.lang.String text)

Given a menu bar it returns the menu displaying the given text.

Parameters:

menubar - menu bar holding the menu.

text - text of the menu sought.

Returns:

menu found.

Throws:

java.lang.AssertionError - if no menu with the given text is found.

getMenu

public static javax.swing.JMenu getMenu(javax.swing.JMenuBar menubar,
                                        java.lang.String string,
                                        Gooey.Match flag)

Given a menu bar it returns the menu associated with the given string. The string acts as an identifier for the menu depending on the flag used. The flag indicates whether we're seeking menus by text or by name.

Parameters:

menubar - menu bar holding the menu.

string - identifier of the menu sought.

flag - to search by text or by name.

Returns:

menu found.

Throws:

java.lang.AssertionError - if no menu with the given string is found.

getMenu

public static <T extends javax.swing.JMenuItem> T getMenu(javax.swing.JMenu menu,
                                                          java.lang.String text)

Given a menu it returns the sub-menu (i.e., another menu or a menu item) displaying the given text. This method searches into nested menus for matches and returns an object of type T sub-classing from JMenuItem.

Type Parameters:

T - class type sub-classing from JMenuItem.

Parameters:

menu - menu holding the sub-menu.

text - text of the menu sought.

Returns:

sub-menu found.

Throws:

java.lang.AssertionError - if no sub-menu with the given text is found.

getMenu

public static <T extends javax.swing.JMenuItem> T getMenu(javax.swing.JMenu menu,
                                                          java.lang.String string,
                                                          Gooey.Match flag)

Given a menu it returns the sub-menu (i.e., another menu or a menu item) associated with the given string. The string acts as an identifier for the sub-menu depending on the flag used. The flag indicates whether we're seeking sub-menus by text or by name.

Type Parameters:

T - class type sub-classing from JMenuItem.

Parameters:

menu - menu holding the sub-menu.

string - identifier of the sub-menu sought.

flag - to search by text or by name.

Returns:

sub-menu found.

Throws:

java.lang.AssertionError - if no sub-menu with the given string is found.

getMenus

public static java.util.List<javax.swing.JMenu> getMenus(javax.swing.JMenuBar menubar)

Returns a list with top-level menus in the menu bar. Nested menus are not traversed.

Parameters:

menubar - menu bar to evaluate.

Returns:

list with the menus in the menu bar.

getMenus

public static java.util.List<javax.swing.JMenuItem> getMenus(javax.swing.JMenu menu)

Returns a list with all sub-menus (i.e., another menu or a menu item) in the menu provided. Nested sub-menus are not traversed.

Parameters:

menu - menu to evaluate.

Returns:

list with the sub-menus in the menu.

getComponent

public static <T extends java.awt.Component> T getComponent(java.awt.Container container,
                                                            java.lang.Class<T> type)

Returns the first component of a class found in a container.

Type Parameters:

T - class type sub-classing from Component.

Parameters:

container - container to evaluate.

type - class of component sought.

Returns:

component found.

Throws:

java.lang.AssertionError - if no component of the given class is found.

getComponent

public static <T extends java.awt.Component> T getComponent(java.awt.Container container,
                                                            java.lang.Class<T> type,
                                                            java.lang.String name)

Returns a component found in the container that matches the given class type and associated name.

Type Parameters:

T - class type sub-classing from Component.

Parameters:

container - container to evaluate.

type - class of component sought.

name - name of the component sought.

Returns:

component found.

Throws:

java.lang.AssertionError - if no component with the given class and name is found.

getComponents

public static <T extends java.awt.Component> java.util.List<T> getComponents(java.awt.Container container,
                                                                             java.lang.Class<T> type)

Returns a list with all components of a given class found in a container.

Type Parameters:

T - class type sub-classing from Component.

Parameters:

container - container to evaluate.

type - class of components sought.

Returns:

list of components found.

getComponents

public static <T extends java.awt.Component> java.util.List<T> getComponents(java.awt.Container container,
                                                                             java.lang.Class<T> type,
                                                                             java.util.function.Predicate<T> criteria)

Returns a list with all components of a given class found in a container that match the given criteria.

Type Parameters:

T - class type sub-classing from Component.

Parameters:

container - container to evaluate.

type - class of components sought.

criteria - criteria indicating an accepting component.

Returns:

list of components found.

capture

public static <T extends GooeyDisplayable<U>,U extends java.awt.Window> void capture(T displayable)

This method uses a capture mechanism, which invokes the method displaying a window, waits for the window to display (within a timeout period) and calls the method to test this window. The parameter displayable is an instance of GooeyDisplayable that implements methods: invoke (calls the code to display a window) and test (calls the code to test the window). If no window is detected within a waiting period the method throws an AssertionError.

Type Parameters:

T - class type sub-classing from Component.

U - class type sub-classing from GooeyDisplayable.

Parameters:

displayable - interface to display and handle the test of a window.

Throws:

java.lang.AssertionError - if no window is displayed.

See Also:

GooeyDisplayable