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     * The {@code PreDestroy} annotation is used on methods as a callback 
040     * notification to signal that the beanlet instance is in the process of being 
041     * removed by the container. Such methods are so-called pre-destroy methods
042     * This annotation is also supported for interceptor methods, further 
043     * referred to as pre-destroy lifecycle methods.</p>
044     *
045     * <p>Pre-destroy methods are typically used to release resources that 
046     * the beanlet has been holding.</p>
047     *
048     * <p><h3>Method Constraints</h3>
049     * The method on which the 
050     * {@code PreDestroy} annotation is applied MUST fulfill all of the following 
051     * criteria:
052     * <ul>
053     * <li>The method MUST NOT have any parameters except in the case of 
054     * interceptors in which case it MUST take an {@code InterceptorContext} object.
055     * <li>The method MAY return any type.
056     * <li>The method MAY throw a checked exception.
057     * <li>The method on which {@code PreDestroy} is applied MAY be {@code public}, 
058     * {@code protected}, package private or {@code private}.
059     * <li>The method MUST NOT be {@code static}.
060     * <li>The method MAY be {@code final}.
061     * </ul>
062     *
063     * {@beanlet.annotation}
064     *
065     * @author Leon van Zantvoort
066     */
067    @Retention(RetentionPolicy.RUNTIME)
068    @Target({ElementType.METHOD})
069    public @interface PreDestroy {
070        
071    }