com.konakart.blif

Interface KKApiMgrIf

All Known Implementing Classes:

KKApiMgr

public interface KKApiMgrIf

KKApiMgrIf Provides some hooks to supplement the execution of the APIs.

Method Summary

Modifier and Type	Method and Description
void	apiEnd(KKApiObjIf obj) Called at the end of the API call - just before returning
KKApiObjIf	apiStart(java.lang.String name) Called at the start of the API call
KKApiObjIf	apiStart(java.lang.String name, boolean debugOnly) Called at the start of the API call
java.lang.String	getElapsed(KKApiObjIf obj) Called at any time to get a String indicating the elapsed time.
long	getElapsedMS(KKApiObjIf obj) Called at any time to get a long indicating the elapsed time.

Method Detail

apiStart

KKApiObjIf apiStart(java.lang.String name)

Called at the start of the API call

Parameters:

name - the API name

Returns:

a KKApiObj object

apiStart

KKApiObjIf apiStart(java.lang.String name,
                    boolean debugOnly)

Called at the start of the API call

Parameters:

name - the API name

debugOnly - Only set up the KKApiObj if debug logging is enabled

Returns:

a KKApiObj object

apiEnd

void apiEnd(KKApiObjIf obj)

Called at the end of the API call - just before returning

Parameters:

obj - the KKApiObjIf returned from the earlier apiStart call

getElapsed

java.lang.String getElapsed(KKApiObjIf obj)

Called at any time to get a String indicating the elapsed time.

Parameters:

obj - the KKApiObjIf returned from the earlier apiStart call

Returns:

a String representing the elapsed time of the API call

getElapsedMS

long getElapsedMS(KKApiObjIf obj)

Called at any time to get a long indicating the elapsed time.

Parameters:

obj - the KKApiObjIf returned from the earlier apiStart call

Returns:

a long representing the elapsed time of the API call in milliseconds