com.amazonaws.services.simpleworkflow.flow.annotations.Asynchronous Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not
 * use this file except in compliance with the License. A copy of the License is
 * located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file 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.amazonaws.services.simpleworkflow.flow.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.amazonaws.services.simpleworkflow.flow.core.Promise;
import com.amazonaws.services.simpleworkflow.flow.core.TryCatchFinally;

/**
 * Call to @Asynchronous method always returns immediately without executing it
 * code. Method body is scheduled for execution after all parameters that extend
 * {@link Promise} and not marked with {@link NoWait} are ready. The only valid
 * return types for @Asynchronous method are void and
 * {@link Promise}.
 * 
 * @author fateev
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Asynchronous {

    /**
     * if set to true treats asynchronous task as a daemon task, allowing the
     * parent asynchronous scope to close if all non-daemon child tasks
     * completes. Default is false which means use the value of the
     * parent task. See {@link TryCatchFinally} for more info on daemon
     * semantic.
     */
    boolean daemon() default false;
}