org.sikuli.script

Class Finder

java.lang.Object

org.sikuli.script.Finder

All Implemented Interfaces:

Iterator<Match>

public class Finder
extends Object
implements Iterator<Match>

Constructor Summary

Constructors

Constructor and Description
Finder(BufferedImage bimg) Constructor for special use from a BufferedImage
Finder(ScreenImage simg) Finder constructor for special use froma a ScreenImage
Finder(ScreenImage simg, Region region) Finder constructor for special use from a ScreenImage
Finder(String imageFilename) Finder constructor (finding within an image).
Finder(String imageFilename, Region region) Finder constructor (finding within an image within the given region).

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() to explicitly free the Finder's resources
protected void	finalize()
String	find(Pattern aPtn) find given pattern within the stored image
String	find(String imageOrText)
String	find(String imageOrText, double minSimilarity)
String	findAll(Pattern aPtn)
String	findAll(String imageOrText)
String	findAll(String imageOrText, double minSimilarity)
protected void	findAllRepeat() internal use: repeat find with same Finder
protected void	findRepeat() internal use: repeat find with same Finder
boolean	hasNext()
Match	next()
void	remove() not used
protected void	setRepeating() internal use: to be able to reuse the same Finder
protected void	setScreenImage(ScreenImage simg) internal use: exchange the source image in existing Finder

Methods inherited from class java.lang.Object

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

Constructor Detail

Finder

public Finder(String imageFilename)
       throws IOException

Finder constructor (finding within an image).
internally used with a screen snapshot

Parameters:

imageFilename - a string (name, path, url)

Throws:

IOException

Finder

public Finder(String imageFilename,
      Region region)
       throws IOException

Finder constructor (finding within an image within the given region).
internally used with a screen snapshot

Parameters:

imageFilename - a string (name, path, url)

region - search Region within image - topleft = (0,0)

Throws:

IOException

Finder

public Finder(BufferedImage bimg)

Constructor for special use from a BufferedImage

Parameters:

bimg -

Finder

public Finder(ScreenImage simg)

Finder constructor for special use froma a ScreenImage

Parameters:

simg -

Finder

public Finder(ScreenImage simg,
      Region region)

Finder constructor for special use from a ScreenImage

Parameters:

simg -

region -

Method Detail

destroy

public void destroy()

to explicitly free the Finder's resources

setScreenImage

protected void setScreenImage(ScreenImage simg)

internal use: exchange the source image in existing Finder

Parameters:

simg -

setRepeating

protected void setRepeating()

internal use: to be able to reuse the same Finder

findRepeat

protected void findRepeat()

internal use: repeat find with same Finder

find

public String find(String imageOrText,
          double minSimilarity)

Parameters:

imageOrText -

minSimilarity -

find

public String find(Pattern aPtn)

find given pattern within the stored image

Parameters:

aPtn -

find

public String find(String imageOrText)

findAllRepeat

protected void findAllRepeat()

internal use: repeat find with same Finder

findAll

public String findAll(String imageOrText,
             double minSimilarity)

Parameters:

imageOrText -

minSimilarity -

findAll

public String findAll(Pattern aPtn)

Parameters:

Pattern -

aPtn -

findAll

public String findAll(String imageOrText)

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Match>

Returns:

true if Finder has a next match, false otherwise

next

public Match next()

Specified by:

next in interface Iterator<Match>

Returns:

the next match or null

remove

public void remove()

not used

Specified by:

remove in interface Iterator<Match>

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable