Package com.jcabi.aspects

Annotation Type Timeable

@Documented
@Retention(RUNTIME)
@Target(METHOD)
public @interface Timeable

Makes a method time constrained.

For example, this load() method should not take more than a second, and should be interrupted if it takes more:

 @Timeable(limit = 1, unit = TimeUnit.SECONDS)
 String load(String resource) {
   // something that runs potentially long
 }

Important to note that in Java 1.5+ it is impossible to force thread termination, for many reasons. Thus, we can't just call Thread.stop(), when a thread is over a specified time limit. The best thing we can do is to call Thread.interrupt() and hope that the thread itself is checking its Thread.isInterrupted() status. If you want to design your long running methods in a way that Timeable can terminate them, embed a checker into your most intessively used place, for example:

 @Timeable(limit = 1, unit = TimeUnit.SECONDS)
 String load(String resource) {
   while (true) {
     if (Thread.currentThread.isInterrupted()) {
       throw new IllegalStateException("time out");
     }
     // execution as usual
   }
 }

Since:

0.7.16

See Also:

http://aspects.jcabi.com/, Why Are Thread.stop, Thread.suspend, Thread.resume and Runtime.runFinalizersOnExit Deprecated?, Limit Java Method Execution Time, by Yegor Bugayenko

Field Summary

Fields

Modifier and Type	Fields	Description
static int	DEFAULT_LIMIT	The default maximum amount (of seconds).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
int	limit	Maximum amount allowed for this method.
TimeUnit	unit	Time unit for the limit.

Field Detail

DEFAULT_LIMIT

static final int DEFAULT_LIMIT

The default maximum amount (of seconds).

Element Detail

limit

int limit

Maximum amount allowed for this method.

Returns:

The limit

Default:

15

unit

TimeUnit unit

Time unit for the limit.

The minimum unit you can use is a second. We simply can't monitor with a frequency higher than a second.

Returns:

The time unit

Default:

java.util.concurrent.TimeUnit.SECONDS