Implement equals and toString properly, fix javadoc

Author: mialeska

src/main/java/aquality/selenium/elements/interfaces/ByImage.java

@@ -24,6 +24,7 @@
 public class ByImage extends By {
     private static boolean wasLibraryLoaded = false;
     private final Mat template;
+    private final String description;
 
     private static void loadLibrary() {
         if (!wasLibraryLoaded) {
@@ -40,24 +41,43 @@ private static void loadLibrary() {
      */
     public ByImage(File file) {
         loadLibrary();
+        description = file.getName();
         this.template = Imgcodecs.imread(file.getAbsolutePath(), Imgcodecs.IMREAD_UNCHANGED);
     }
 
     /**
-     * Constructor accepting image file.
+     * Constructor accepting image bytes.
      *
      * @param bytes image bytes to locate element by.
      */
     public ByImage(byte[] bytes) {
         loadLibrary();
+        description = String.format("bytes[%d]", bytes.length);
         this.template = Imgcodecs.imdecode(new MatOfByte(bytes), Imgcodecs.IMREAD_UNCHANGED);
     }
 
     @Override
     public String toString() {
-        return "ByImage: " + new Dimension(template.width(), template.height());
+        return String.format("ByImage: %s, size: (width:%d, height:%d)", description, template.width(), template.height());
     }
 
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof ByImage)) {
+            return false;
+        }
+
+        ByImage that = (ByImage) o;
+
+        return this.template.equals(that.template);
+    }
+
+    @Override
+    public int hashCode() {
+        return template.hashCode();
+    }
+
+
     @Override
     public List<WebElement> findElements(SearchContext context) {
         Mat source = getScreenshot(context);

src/test/java/tests/integration/LocatorTests.java

@@ -48,7 +48,7 @@ public void testByImageLocator() {
 
         ILabel documentByTag = AqualityServices.getElementFactory().getLabel(By.tagName("body"), "document by tag");
         ILabel documentByImage = AqualityServices.getElementFactory().getLabel(new ByImage(documentByTag.getElement().getScreenshotAs(OutputType.BYTES)),
-                "full screen");
+                "body screen");
         Assert.assertTrue(documentByImage.state().isDisplayed(), "Should be possible to find element by document screenshot");
         Assert.assertEquals(documentByImage.getElement().getTagName(), "body", "Correct element must be found");
     }