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.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 package org.jemmy.image;
  24 
  25 import org.jemmy.Point;
  26 
  27 import java.awt.image.BufferedImage;
  28 
  29 /**
  30  * Interface for all classes performing image lookup.
  31  *
  32  * @author Alexandre Iline (alexandre.iline@sun.com)
  33  */
  34 public interface ImageFinder {
  35 
  36     /**
  37      * Should return location if image lays inside an image represented by this object.
  38      * @param image an image to search.
  39      * @param index an ordinal image location index. If equal to 1, for example,
  40      * second appropriate location will be found.
  41      * @return Image location coordinates if image was found, null otherwise.
  42      */
  43     public Point findImage(BufferedImage image, int index);
  44 }