com.github.dm.jrt.object.annotation.Priority Maven / Gradle / Ivy
/*
* Copyright 2016 Davide Maestroni
*
* 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.github.dm.jrt.object.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Through this annotation it is possible to indicate the priority of the specific method
* invocation.
*
* This annotation is used to decorate methods that are to be invoked in an asynchronous way.
*
* Note that the piece of code inside such methods will be automatically protected so to avoid
* concurrency issues. Though, other parts of the code inside the same class will be not.
*
* In order to prevent unexpected behaviors, it is advisable to avoid using the same class fields
* (unless immutable) in protected and non-protected code, or to call synchronous methods through
* routines as well.
*
* Finally, be aware that a method might need to be made accessible in order to be called. That
* means that, in case a {@link java.lang.SecurityManager} is installed, a security exception might
* be raised based on the specific policy implemented.
*
* Remember also that, in order for the annotation to properly work at run time, the following rules
* must be added to the project Proguard file (if employed for shrinking or obfuscation):
*
*
*
* -keepattributes RuntimeVisibleAnnotations
* -keepclassmembers class ** {
* @com.github.dm.jrt.object.annotation.Priority *;
* }
*
*
*
* Created by davide-maestroni on 05/31/2015.
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Priority {
/**
* The priority value.
*
* @return the priority.
*/
int value();
}