1 /*
2 * Copyright (c) 2012-2024, jcabi.com
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met: 1) Redistributions of source code must retain the above
8 * copyright notice, this list of conditions and the following
9 * disclaimer. 2) Redistributions in binary form must reproduce the above
10 * copyright notice, this list of conditions and the following
11 * disclaimer in the documentation and/or other materials provided
12 * with the distribution. 3) Neither the name of the jcabi.com nor
13 * the names of its contributors may be used to endorse or promote
14 * products derived from this software without specific prior written
15 * permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package com.jcabi.aspects;
31
32 import java.lang.annotation.Documented;
33 import java.lang.annotation.ElementType;
34 import java.lang.annotation.Retention;
35 import java.lang.annotation.RetentionPolicy;
36 import java.lang.annotation.Target;
37
38 /**
39 * Marks a method for asynchronous execution.
40 *
41 * <p>Add this annotation to the method you want to execute asynchronously.
42 * Methods of return type {@code void} and {@link java.util.concurrent.Future}
43 * are supported. In the latter case, an actual asynchronous Future will be
44 * returned, but the target method should return a temporary {@code Future}
45 * that passes the value through as the return type needs to be the same.
46 *
47 * <p>Usage with other return types may cause unexpected behavior (because
48 * {@code NULL} will always be returned).
49 *
50 * <p>Keep in mind that there is a limited number of threads working with
51 * methods annotated with <code>@Async</code>. Thus, if one of your
52 * methods keep a thread busy for a long time, others will wait. Try to
53 * make all methods fast, when you annotate them with <code>@Async</code>.
54 *
55 * @see <a href="http://aspects.jcabi.com">http://aspects.jcabi.com/</a>
56 * @since 0.16
57 */
58 @Documented
59 @Target(ElementType.METHOD)
60 @Retention(RetentionPolicy.RUNTIME)
61 public @interface Async {
62 }