Document the contract of DatabaseExecutor.

This commit is contained in:
akwizgran
2014-11-08 16:40:22 +00:00
parent 4009561996
commit 9dbabdeceb
3 changed files with 10 additions and 3 deletions

View File

@@ -10,7 +10,13 @@ import java.lang.annotation.Target;
import com.google.inject.BindingAnnotation;
/** Annotation for injecting the executor for database tasks. */
/**
* Annotation for injecting the executor for database tasks.
* <p>
* The contract of this executor is that tasks are executed in the order
* they're submitted, tasks are not executed concurrently, and submitting a
* task will never block.
*/
@BindingAnnotation
@Target({ FIELD, METHOD, PARAMETER })
@Retention(RUNTIME)