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
029     * http://beanlet.org
030     */
031    package org.beanlet;
032    
033    import java.lang.annotation.ElementType;
034    import java.lang.annotation.Retention;
035    import java.lang.annotation.RetentionPolicy;
036    import java.lang.annotation.Target;
037    
038    /**
039     * <p>Defines a stop lifecycle method.</p>
040     *
041     * <p><h3>Method Constraints</h3>
042     * The method on which the {@code Stop} 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 Stop 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 Stop {
062        
063        /**
064         * Description of the underlying stop method.
065         */
066        String description() default "";
067    }