com.aspc.developer

Class ThreadCop

java.lang.Object

com.aspc.developer.ThreadCop

public final class ThreadCop
extends java.lang.Object

Thread Cop is designed to make sure that an object is called in the correct manner, not that the object handles the call correctly. If an object is single threaded then it is only called by one thread.
THREAD MODE: MULTI-THREADED singleton

Since:

9 November 2009

Author:

Nigel Leck

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ThreadCop.ACCESS the access type
static class	ThreadCop.MODE the thread modes

Method Summary

Modifier and Type	Method and Description
static boolean	access(java.lang.Object target) modify access
static boolean	access(java.lang.Object target, ThreadCop.ACCESS access) check the thread access of the object
static boolean	addPauseAt(java.lang.String position, long timeToPause) add pause to a location
static void	causeExceptionAt(java.lang.String position) cause an exception at
static boolean	checkExceptionAt(java.lang.String position) cause an exception at
static boolean	checkFlowControlException(java.lang.Throwable t) check that this a flow control exception
static boolean	clearLocations() clear all pauses.
static ThreadCop.MODE	currentMonitor(java.lang.Object target) monitor the object
static boolean	enter(java.lang.Object target) The are entering the target object
static boolean	enter(java.lang.Object target, ThreadCop.ACCESS access) The are entering the target object
static long	errorCount() The total error count
static long	incrementErrorCount() increment the error count
static ThreadCopError	lastError() The last error that occurred.
static boolean	leave(java.lang.Object target) The are leaving the target object
static boolean	modify(java.lang.Object target) modify access
static boolean	monitor(java.lang.Object target, ThreadCop.MODE mode) monitor the object
static boolean	pauseAt(java.lang.String position) pause at a location
static boolean	popMonitor(java.lang.Object target) monitor the object
static boolean	pushMonitor(java.lang.Object target, ThreadCop.MODE mode) monitor the object
static boolean	read(java.lang.Object target) read access
static void	recordLastError(ThreadCopError lastError) record the last error that occurred.

Methods inherited from class java.lang.Object

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

Method Detail

checkFlowControlException

public static boolean checkFlowControlException(java.lang.Throwable t)

check that this a flow control exception

Parameters:

t -

Returns:

the value

clearLocations

public static boolean clearLocations()

clear all pauses.

Returns:

always TRUE

addPauseAt

public static boolean addPauseAt(java.lang.String position,
                                 long timeToPause)

add pause to a location

Parameters:

position - this position

timeToPause - now long to pause

Returns:

always TRUE

pauseAt

public static boolean pauseAt(java.lang.String position)

pause at a location

Parameters:

position - this position

Returns:

always TRUE

causeExceptionAt

public static void causeExceptionAt(java.lang.String position)

cause an exception at

Parameters:

position - this position

checkExceptionAt

public static boolean checkExceptionAt(java.lang.String position)

cause an exception at

Parameters:

position - this position

Returns:

true

errorCount

public static long errorCount()

The total error count

Returns:

the count

lastError

public static ThreadCopError lastError()

The last error that occurred.

Returns:

the last error.

recordLastError

public static void recordLastError(ThreadCopError lastError)

record the last error that occurred.

Parameters:

lastError - the last error.

pushMonitor

public static boolean pushMonitor(@Nullable
                                  java.lang.Object target,
                                  @Nonnull
                                  ThreadCop.MODE mode)

monitor the object

Parameters:

target - the target object

mode - the access mode

Returns:

always true

popMonitor

public static boolean popMonitor(java.lang.Object target)

monitor the object

Parameters:

target - the target object

Returns:

always true

currentMonitor

@CheckReturnValue
 @Nonnull
public static ThreadCop.MODE currentMonitor(@Nonnull
                                                                        java.lang.Object target)

monitor the object

Parameters:

target - the target object

Returns:

always true

monitor

public static boolean monitor(java.lang.Object target,
                              ThreadCop.MODE mode)

monitor the object

Parameters:

target - the target object

mode - the access mode

Returns:

always true

read

public static boolean read(java.lang.Object target)

read access

Parameters:

target - the target object

Returns:

always true

modify

public static boolean modify(java.lang.Object target)

modify access

Parameters:

target - the target object

Returns:

always true

access

public static boolean access(java.lang.Object target)

modify access

Parameters:

target - the target object

Returns:

always true

access

public static boolean access(java.lang.Object target,
                             ThreadCop.ACCESS access)

check the thread access of the object

Parameters:

target - the target object

access - the type of access

Returns:

always true

enter

public static boolean enter(java.lang.Object target)

The are entering the target object

Parameters:

target - the target object

Returns:

always true

enter

public static boolean enter(java.lang.Object target,
                            ThreadCop.ACCESS access)

The are entering the target object

Parameters:

target - the target object

access - the type of access

Returns:

always true

leave

public static boolean leave(java.lang.Object target)

The are leaving the target object

Parameters:

target - the target object

Returns:

always true

incrementErrorCount

public static long incrementErrorCount()

increment the error count

Returns:

the current count