001 /*
002 * ============================================================================
003 * GNU Lesser General Public License
004 * ============================================================================
005 *
006 * Beanlet - JSE Application Container.
007 * Copyright (C) 2006 Leon van Zantvoort
008 *
009 * This library is free software; you can redistribute it and/or
010 * modify it under the terms of the GNU Lesser General Public
011 * License as published by the Free Software Foundation; either
012 * version 2.1 of the License, or (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful,
015 * but WITHOUT ANY WARRANTY; without even the implied warranty of
016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017 * Lesser General Public License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
022 *
023 * Leon van Zantvoort
024 * 243 Acalanes Drive #11
025 * Sunnyvale, CA 94086
026 * USA
027 *
028 * zantvoort@users.sourceforge.net * http://beanlet.org
029 */
030 package org.beanlet;
031
032 import java.lang.annotation.ElementType;
033 import java.lang.annotation.Retention;
034 import java.lang.annotation.RetentionPolicy;
035 import java.lang.annotation.Target;
036
037 /**
038 * <p>Methods declared with this annotation are executed by one or more
039 * background threads.</p>
040 *
041 * <p><h3>Method Constraints</h3>
042 * The method on which the {@code Execute} annotation is applied MUST fulfill all
043 * of the following criteria:
044 * <ul>
045 * <li>The method MUST NOT have any parameters.
046 * <li>The method MAY return any type.
047 * <li>The method MAY throw a checked exception.
048 * <li>The method on which {@code Execute} is applied MAY be {@code public},
049 * {@code protected}, package private or {@code private}.
050 * <li>The method MUST NOT be {@code static}.
051 * <li>The method MAY be {@code final}.
052 * </ul>
053 * </p>
054 *
055 * {@beanlet.annotation}
056 *
057 * @author Leon van Zantvoort
058 */
059 @Retention(RetentionPolicy.RUNTIME)
060 @Target(ElementType.METHOD)
061 public @interface Execute {
062
063 /**
064 * Number of threads that call the runnable method concurrently.
065 */
066 int threads() default 1;
067
068 /**
069 * If {@code true}, the method is called in a loop.
070 */
071 boolean loop() default false;
072
073 /**
074 * If {@code true}, the running threads are interrupted on destroy.
075 */
076 boolean interrupt() default false;
077
078 /**
079 * If {@code true}, the container waits until this component has finished
080 * the runnable method on destroy.
081 */
082 boolean join() default false;
083
084 /**
085 * Description of the underlying executalbe method.
086 */
087 String description() default "";
088 }