1 /*
   2  * Copyright (c) 2007, 2017 Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation. Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package org.jemmy.image;
  27 
  28 /**
  29  * Interface for all classes performing image comparison.
  30  *
  31  * @author Alexandre Iline (alexandre.iline@sun.com)
  32  */
  33 public interface ImageComparator {
  34 
  35     /**
  36      * Checks if images are the same according to whatever comparison logic is used.
  37      * @param image1 an image to compare.
  38      * @param image2 an image to compare.
  39      * @return null if images match each other; difference otherwise
  40      */
  41     public Image compare(Image image1, Image image2);
  42 
  43     /**
  44      * A string qualifying an image comparison algorithm. To be used in logs and
  45      * tools.
  46      * @return
  47      */
  48     public String getID();
  49 }