com.phloc.commons.annotations.MustBeLocked Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2014 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.phloc.commons.annotations;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.annotation.Nonnull;
/**
* Just to indicate that a method must be called inside a lock. When using
* read-write locks (class ReadWriteLock), please choose the lock type
* carefully. When using exclusive locks (class Lock) use the lock type
* WRITE. The constraint of this annotation is also fulfilled when
* a method is called inside the constructor of the owning class, as
* constructor-calls of a single object are not accessed by multiple threads in
* parallel.
*
* @author Philip Helger
*/
@Retention (RetentionPolicy.CLASS)
@Target ({ ElementType.METHOD })
@Documented
public @interface MustBeLocked
{
public static enum ELockType
{
READ,
WRITE
}
@Nonnull
ELockType value();
}