ENH(Refactor class names to ease coding)

Author: mmarquee

src/main/java/mmarquee/automation/UIAutomation.java

@@ -21,17 +21,17 @@
  * @author Mark Humphreys
  * Date 02/03/2016.
  */
-public class AutomationAppBar extends AutomationBase {
+public class AppBar extends AutomationBase {
     /**
      * <p>
-     * Constructor for the AutomationAppBar.
+     * Constructor for the AppBar.
      * </p>
      * <p>
      * This element seems to be undocumented by Microsoft
      * </p>
      * @param builder The builder
      */
-    public AutomationAppBar(final ElementBuilder builder) {
+    public AppBar(final ElementBuilder builder) {
         super(builder);
     }
 }

src/main/java/mmarquee/automation/controls/AutomationAppBar.java renamed to src/main/java/mmarquee/automation/controls/AppBar.java

@@ -35,7 +35,7 @@
  * @author Mark Humphreys
  * Date 26/01/2016.
  */
-public class AutomationApplication extends AutomationBase {
+public class Application extends AutomationBase {
 
     /**
      * The window handle.
@@ -115,10 +115,10 @@ public void waitForInputIdle() {
     /**
      * Gets the window associated with the title.
      * @param title The title to look for.
-     * @return An AutomationWindow.
+     * @return An Window.
      * @throws AutomationException Cannot find element.
      */
-    public AutomationWindow getWindow(final String title)
+    public Window getWindow(final String title)
             throws AutomationException {
 
         AutomationElement foundElement = null;
@@ -134,7 +134,7 @@ public AutomationWindow getWindow(final String title)
         }
 
         if (foundElement != null) {
-            return new AutomationWindow(new ElementBuilder(foundElement));
+            return new Window(new ElementBuilder(foundElement));
         } else {
             throw new ElementNotFoundException(title);
         }
@@ -143,10 +143,10 @@ public AutomationWindow getWindow(final String title)
     /**
      * Gets the window associated with the classname.
      * @param className The class name of the element to look for
-     * @return An AutomationWindow.
+     * @return An Window.
      * @throws AutomationException Cannot find element.
      */
-    public AutomationWindow getWindowByClassName(final String  className)
+    public Window getWindowByClassName(final String  className)
             throws AutomationException {
 
         AutomationElement foundElement = null;
@@ -162,7 +162,7 @@ public AutomationWindow getWindowByClassName(final String  className)
         }
 
         if (foundElement != null) {
-            return new AutomationWindow(new ElementBuilder(foundElement));
+            return new Window(new ElementBuilder(foundElement));
         } else {
             throw new ElementNotFoundException("matching " + className);
         }
@@ -171,10 +171,10 @@ public AutomationWindow getWindowByClassName(final String  className)
     /**
      * Gets the window associated with the title.
      * @param titlePattern A pattern matching the title to look for.
-     * @return An AutomationWindow.
+     * @return An Window.
      * @throws AutomationException Cannot find element.
      */
-    public AutomationWindow getWindow(final Pattern titlePattern)
+    public Window getWindow(final Pattern titlePattern)
             throws AutomationException {
 
         AutomationElement foundElement = null;
@@ -190,7 +190,7 @@ public AutomationWindow getWindow(final Pattern titlePattern)
         }
 
         if (foundElement != null) {
-            return new AutomationWindow(new ElementBuilder(foundElement));
+            return new Window(new ElementBuilder(foundElement));
         } else {
             throw new ElementNotFoundException("matching " + titlePattern);
         }
@@ -203,7 +203,7 @@ public AutomationWindow getWindow(final Pattern titlePattern)
      * @return The found control
      * @throws AutomationException Something has gone wrong
      */
-    public AutomationWindow getWindow(final Search search)
+    public Window getWindow(final Search search)
             throws AutomationException {
         if (search.getHasNamePattern()) {
             return getWindow(search.getNamePattern());
@@ -217,11 +217,11 @@ public AutomationWindow getWindow(final Search search)
     }
 
     /**
-     * Constructor for the AutomationApplication.
+     * Constructor for the Application.
      *
      * @param builder The builder
      */
-    public AutomationApplication(final ElementBuilder builder) {
+    public Application(final ElementBuilder builder) {
         super(builder);
         this.isAttached = builder.getAttached();
         this.user32 = builder.getUser32();

src/main/java/mmarquee/automation/controls/AutomationApplication.java renamed to src/main/java/mmarquee/automation/controls/Application.java

@@ -610,7 +610,7 @@ protected PointerByReference createAndCondition(
      * @return IUIAutomationElementArray
      * @throws AutomationException Error in automation library
      */
-    protected List<AutomationElement> findAll(
+    protected java.util.List <AutomationElement> findAll(
             final TreeScope scope,
             final PointerByReference condition)
             throws AutomationException {

src/main/java/mmarquee/automation/controls/AutomationBase.java

@@ -67,86 +67,86 @@ static AutomationBase get(final AutomationBase parent,
     	String className = element.getClassName();
     	switch (controlType) {
     	case Button:
-    		return new AutomationButton(new ElementBuilder(element));
+    		return new Button(new ElementBuilder(element));
     	case Calendar:
-    		return new AutomationCalendar(new ElementBuilder(element));
+    		return new Calendar(new ElementBuilder(element));
     	case CheckBox:
-    		return new AutomationCheckBox(new ElementBuilder(element));
+    		return new CheckBox(new ElementBuilder(element));
     	case ComboBox:
-    		return new AutomationComboBox(new ElementBuilder(element));
+    		return new ComboBox(new ElementBuilder(element));
     	case Edit:
-			if (AutomationPasswordEditBox.CLASS_NAME.equals(className)) {
-				return new AutomationPasswordEditBox(new ElementBuilder(element));
-			} else if (AutomationMaskedEdit.CLASS_NAME.equals(className)) {
-				return new AutomationMaskedEdit(new ElementBuilder(element));
+			if (PasswordEditBox.CLASS_NAME.equals(className)) {
+				return new PasswordEditBox(new ElementBuilder(element));
+			} else if (MaskedEdit.CLASS_NAME.equals(className)) {
+				return new MaskedEdit(new ElementBuilder(element));
 			}
-    		return new AutomationEditBox(new ElementBuilder(element));
+    		return new EditBox(new ElementBuilder(element));
     	case Hyperlink:
-    		return new AutomationHyperlink(new ElementBuilder(element));
+    		return new Hyperlink(new ElementBuilder(element));
     	case Image:
-    		return new AutomationImage(new ElementBuilder(element));
+    		return new Image(new ElementBuilder(element));
     	case ListItem:
-    		return new AutomationListItem(new ElementBuilder(element));
+    		return new ListItem(new ElementBuilder(element));
     	case List:
-    		return new AutomationList(new ElementBuilder(element));
+    		return new List(new ElementBuilder(element));
     	case Menu:
     		return new AutomationMenu(new ElementBuilder(element));
     	case MenuBar:
     		return new AutomationMainMenu(new ElementBuilder(element).parent(parent.getElement()));
     	case MenuItem:
     		return new AutomationMenuItem(new ElementBuilder(element));
     	case ProgressBar:
-    		return new AutomationProgressBar(new ElementBuilder(element));
+    		return new ProgressBar(new ElementBuilder(element));
     	case RadioButton:
-    		return new AutomationRadioButton(new ElementBuilder(element));
+    		return new RadioButton(new ElementBuilder(element));
     	case Slider:
-    		return new AutomationSlider(new ElementBuilder(element));
+    		return new Slider(new ElementBuilder(element));
     	case Spinner:
-    		return new AutomationSpinner(new ElementBuilder(element));
+    		return new Spinner(new ElementBuilder(element));
     	case StatusBar:
-    		return new AutomationStatusBar(new ElementBuilder(element));
+    		return new StatusBar(new ElementBuilder(element));
     	case Tab:
-    		return new AutomationTab(new ElementBuilder(element));
+    		return new Tab(new ElementBuilder(element));
     	case TabItem:
-    		return new AutomationTabItem(new ElementBuilder(element));
+    		return new TabItem(new ElementBuilder(element));
     	case Text:
-    		return new AutomationTextBox(new ElementBuilder(element));
+    		return new TextBox(new ElementBuilder(element));
     	case ToolBar:
-    		return new AutomationToolBar(new ElementBuilder(element));
+    		return new ToolBar(new ElementBuilder(element));
     	case Tree:
-    		return new AutomationTreeView(new ElementBuilder(element));
+    		return new TreeView(new ElementBuilder(element));
     	case TreeItem:
-    		return new AutomationTreeViewItem(new ElementBuilder(element));
+    		return new TreeViewItem(new ElementBuilder(element));
     	case Custom:
-    		return new AutomationCustom(new ElementBuilder(element));
+    		return new Custom(new ElementBuilder(element));
     	case DataGrid:
-    		return new AutomationDataGrid(new ElementBuilder(element));
+    		return new DataGrid(new ElementBuilder(element));
     	case Document:
-    		return new AutomationDocument(new ElementBuilder(element));
+    		return new Document(new ElementBuilder(element));
     	case SplitButton:
-    		return new AutomationSplitButton(new ElementBuilder(element));
+    		return new SplitButton(new ElementBuilder(element));
     	case Window:
-    		return new AutomationWindow(new ElementBuilder(element));
+    		return new Window(new ElementBuilder(element));
     	case Pane:
 			switch (className) {
-				case AutomationReBar.CLASS_NAME:
-					return new AutomationReBar(new ElementBuilder(element));
-				case AutomationRibbonBar.CLASS_NAME:
-					return new AutomationRibbonBar(new ElementBuilder(element));
-				case AutomationRibbonCommandBar.CLASS_NAME:
-					return new AutomationRibbonCommandBar(new ElementBuilder(element));
-				case AutomationRibbonWorkPane.CLASS_NAME:
-					return new AutomationRibbonWorkPane(new ElementBuilder(element));
-				case AutomationNUIPane.CLASS_NAME:
-					return new AutomationNUIPane(new ElementBuilder(element));
-				case AutomationNetUIHWND.CLASS_NAME:
-					return new AutomationNetUIHWND(new ElementBuilder(element));
+				case ReBar.CLASS_NAME:
+					return new ReBar(new ElementBuilder(element));
+				case RibbonBar.CLASS_NAME:
+					return new RibbonBar(new ElementBuilder(element));
+				case RibbonCommandBar.CLASS_NAME:
+					return new RibbonCommandBar(new ElementBuilder(element));
+				case RibbonWorkPane.CLASS_NAME:
+					return new RibbonWorkPane(new ElementBuilder(element));
+				case NUIPane.CLASS_NAME:
+					return new NUIPane(new ElementBuilder(element));
+				case NetUIHWND.CLASS_NAME:
+					return new NetUIHWND(new ElementBuilder(element));
 			}
-    		return new AutomationPanel(new ElementBuilder(element));
+    		return new Panel(new ElementBuilder(element));
     	case TitleBar:
-    		return new AutomationTitleBar(new ElementBuilder(element));
+    		return new TitleBar(new ElementBuilder(element));
     	case AppBar:
-    		return new AutomationAppBar(new ElementBuilder(element));
+    		return new AppBar(new ElementBuilder(element));
     		// No Custom controls, yet:
     	case ScrollBar:
     	case ToolTip:
@@ -160,7 +160,7 @@ static AutomationBase get(final AutomationBase parent,
     	case SemanticZoom:
     	default:
     		// best try
-            return new AutomationContainer(new ElementBuilder(element));
+            return new Container(new ElementBuilder(element));
     	}
     }
 }

src/main/java/mmarquee/automation/controls/AutomationControlFactory.java

@@ -25,9 +25,11 @@
  * @author Mark Humphreys
  * Date 02/02/2016.
  */
-public class AutomationButton
+public class Button
         extends AutomationBase
-        implements ImplementsClick, ImplementsFocus, ImplementsLegacyIAccessible {
+        implements ImplementsClick,
+                   ImplementsFocus,
+                   ImplementsLegacyIAccessible {
     /**
      * The control type.
      */
@@ -39,11 +41,11 @@ public class AutomationButton
     private LegacyIAccessible accessiblePattern;
 
     /**
-     * Constructor for the AutomationButton.
+     * Constructor for the Button.
      *
      * @param builder The builder
      */
-    public AutomationButton(final ElementBuilder builder) {
+    public Button(final ElementBuilder builder) {
         super(builder);
     }
 
@@ -77,7 +79,8 @@ public String getValueFromIAccessible()
             throws PatternNotFoundException, AutomationException {
         if (this.accessiblePattern == null) {
             try {
-                this.accessiblePattern = this.requestAutomationPattern(LegacyIAccessible.class);
+                this.accessiblePattern =
+                        this.requestAutomationPattern(LegacyIAccessible.class);
             } catch (NullPointerException ex) {
                 getLogger().info("No value pattern available");
             }
@@ -99,7 +102,8 @@ public void setValueFromIAccessible(final String value)
             throws AutomationException {
         if (this.accessiblePattern == null)  {
             try {
-                this.accessiblePattern = this.requestAutomationPattern(LegacyIAccessible.class);
+                this.accessiblePattern =
+                        this.requestAutomationPattern(LegacyIAccessible.class);
                 this.accessiblePattern.setCurrentValue(value);
             } catch (NullPointerException ex) {
                 getLogger().info("No value pattern available");

src/main/java/mmarquee/automation/controls/AutomationButton.java renamed to src/main/java/mmarquee/automation/controls/Button.java

@@ -26,17 +26,15 @@
  *
  * Implements IGridProvider, IScrollProvider, ITableProvider, IValueProvider
  */
-public class AutomationCalendar extends AutomationBase implements ImplementsValue {
+public class Calendar extends AutomationBase
+        implements ImplementsValue {
 
     /**
-     * Constructor for the AutomationCalendar.
+     * Constructor for the Calendar.
      *
-     * @param builder The element builder.
-     * @throws AutomationException Automation library error.
-     * @throws PatternNotFoundException Expected pattern not found.
+     * @param builder The element builder
      */
-    public AutomationCalendar(final ElementBuilder builder)
-            throws PatternNotFoundException, AutomationException {
+    public Calendar(final ElementBuilder builder) {
         super(builder);
     }
 }

src/main/java/mmarquee/automation/controls/AutomationCalendar.java renamed to src/main/java/mmarquee/automation/controls/Calendar.java

@@ -22,17 +22,17 @@
  * @author Mark Humphreys
  * Date 31/01/2016.
  */
-public final class AutomationCheckBox
+public final class CheckBox
         extends AutomationBase
-        implements ImplementsToggle, ImplementsFocus {
-
+        implements ImplementsToggle,
+                   ImplementsFocus {
 
     /**
-     * Constructor for the AutomationCheckBox.
+     * Constructor for the CheckBox.
      *
      * @param builder The builder
      */
-    public AutomationCheckBox (final ElementBuilder builder) {
+    public CheckBox(final ElementBuilder builder) {
         super (builder);
     }