org.apache.deltaspike.core.api.lock

Annotation Type Locked

@InterceptorBinding
@Retention(value=RUNTIME)
@Target(value={TYPE,METHOD})
public @interface Locked

The access to the method is protected by a read/write lock.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends Locked.LockFactory>	factory
boolean	fair
Locked.Operation	operation
long	timeout
TimeUnit	timeoutUnit

Element Detail

fair

public abstract boolean fair

Returns:

if the lock is fair.

Default:

false

operation

public abstract Locked.Operation operation

Returns:

the operation used on the lock, default to read but you can use write.

Default:

org.apache.deltaspike.core.api.lock.Locked.Operation.READ

factory

public abstract Class<? extends Locked.LockFactory> factory

Returns:

how to retrieve the lock for this method. Default uses a lock per class.

Default:

org.apache.deltaspike.core.api.lock.Locked.LockFactory.class

timeout

public abstract long timeout

Returns:

the access timeout for this method. Ignored by default since it is 0.

Default:

0L

timeoutUnit

public abstract TimeUnit timeoutUnit

Returns:

the timeout unit (default ms).

Default:

java.util.concurrent.TimeUnit.MILLISECONDS