Package org.sikuli.script

Class FindFailed

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.sikuli.script.SikuliException

org.sikuli.script.FindFailed

All Implemented Interfaces:

Serializable

public class FindFailed
extends SikuliException

SikuliX FindFailed exception
constants and settings for the features
FindFailedResponse
FindFailedHandler
ImageMissingHandler

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static FindFailedResponse	ABORT	FindFailedResponse ABORT: should abort the SikuliX application
static FindFailedResponse	HANDLE	FindFailedResponse HANDLE: should call a handler setFindFailedHandler(Object) on FindFailed
static FindFailedResponse	PROMPT	FindFailedResponse PROMPT: should display a prompt dialog with the failing image having the options retry, skip and abort
static FindFailedResponse	RETRY	FindFailedResponse RETRY: should retry the find op on FindFailed
static FindFailedResponse	SKIP	FindFailedResponse SKIP: should silently continue on FindFailed

Fields inherited from class org.sikuli.script.SikuliException

_name

Constructor Summary

Constructors

Constructor	Description
FindFailed(String message)	the exception

Method Summary

Modifier and Type	Method	Description
static String	createErrorMessage(Region reg, Image img)
static Object	getFindFailedHandler()
static Object	getImageMissingHandler()
static FindFailedResponse	getResponse()
static void	reset()	reset all: response ABORT, findFailedHandler null, imageMissingHandler null
static void	resetFindFailedHandler()	reset to default: no handler, response ABORT
static void	resetImageMissingHandler()	reset to default: no handler
static void	resetResponse()	reset to default setResponse(FindFailedResponse)
static void	setFindFailedHandler(Object handler)	Global FindFailedHandler for new Regions default: none
static Object	setHandler(Object handler, ObserveEvent.Type type)
static void	setImageMissingHandler(Object handler)	Global ImageMissingHandler for new Regions default: none
static void	setResponse(FindFailedResponse response)	Global FindFailedResponse for new Regions ABORT - abort script on FindFailed SKIP - ignore FindFailed PROMPT - display prompt on FindFailed to let user decide how to proceed RETRY - continue to wait for appearence after FindFailed HANDLE - (set implicit) call a handler on exception setFindFailedHandler(Object) default: ABORT

Methods inherited from class org.sikuli.script.SikuliException

toString, toStringShort

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

PROMPT

public static final FindFailedResponse PROMPT

FindFailedResponse PROMPT: should display a prompt dialog with the failing image having the options retry, skip and abort

RETRY

public static final FindFailedResponse RETRY

FindFailedResponse RETRY: should retry the find op on FindFailed

SKIP

public static final FindFailedResponse SKIP

FindFailedResponse SKIP: should silently continue on FindFailed

ABORT

public static final FindFailedResponse ABORT

FindFailedResponse ABORT: should abort the SikuliX application

HANDLE

public static final FindFailedResponse HANDLE

FindFailedResponse HANDLE: should call a handler setFindFailedHandler(Object) on FindFailed

Constructor Detail

FindFailed

public FindFailed(String message)

the exception

Parameters:

message - to be shown

Method Detail

reset

public static void reset()

reset all: response ABORT, findFailedHandler null, imageMissingHandler null

setResponse

public static void setResponse(FindFailedResponse response)

Global FindFailedResponse for new Regions
ABORT - abort script on FindFailed
SKIP - ignore FindFailed
PROMPT - display prompt on FindFailed to let user decide how to proceed
RETRY - continue to wait for appearence after FindFailed
HANDLE - (set implicit) call a handler on exception setFindFailedHandler(Object)
default: ABORT

Parameters:

response - FindFailed

resetResponse

public static void resetResponse()

reset to default setResponse(FindFailedResponse)

getResponse

public static FindFailedResponse getResponse()

Returns:

the current setting setResponse(FindFailedResponse)

setFindFailedHandler

public static void setFindFailedHandler(Object handler)

Global FindFailedHandler for new Regions
default: none

Parameters:

handler - ObserverCallBack

resetFindFailedHandler

public static void resetFindFailedHandler()

reset to default: no handler, response ABORT

getFindFailedHandler

public static Object getFindFailedHandler()

Returns:

the current handler

setImageMissingHandler

public static void setImageMissingHandler(Object handler)

Global ImageMissingHandler for new Regions
default: none

Parameters:

handler - ObserverCallBack

resetImageMissingHandler

public static void resetImageMissingHandler()

reset to default: no handler

getImageMissingHandler

public static Object getImageMissingHandler()

Returns:

the current handler

setHandler

public static Object setHandler(Object handler,
                                ObserveEvent.Type type)

createErrorMessage

public static String createErrorMessage(Region reg,
                                        Image img)