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.Target;
035    
036    /**
037     * <p>Indicates what action is to be taken in case an exception is encountered 
038     * on beanlet invocation.</p>
039     *
040     * <p>Beanlet instances are returned to the pool after invocation automatically, 
041     * unless an exception is raised that matches the exception type
042     * specified by this annotation. In this case, the retention policy is executed
043     * as specified.</p>
044     * 
045     * <p><h3>XML Representation</h3>The following xml-fragment shows how to express this annotation in xml.<br><pre><tt>&lt;beanlets xmlns="http://beanlet.org/schema/beanlet"
046     *          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
047     *          xsi:schemaLocation="http://beanlet.org/schema/beanlet http://beanlet.org/schema/beanlet/beanlet_1_0.xsd"&gt;
048     *  &lt;beanlet name="foo" type="com.acme.Foo"&gt;
049     *    <b>&lt;retention value="INVALIDATE"&gt;
050     *      &lt;class type="java.lang.RuntimeException"/&gt;
051     *      &lt;class type="java.lang.Error"/&gt;
052     *    &lt;/retention&gt;</b>
053     *  &lt;/beanlet&gt;
054     *&lt;/beanlets&gt;</tt></pre></p>
055     *
056     * @see RetentionPolicy
057     * @author Leon van Zantvoort
058     */
059    @java.lang.annotation.Retention(java.lang.annotation.RetentionPolicy.RUNTIME)
060    @Target(ElementType.TYPE)
061    public @interface Retention {
062    
063        Class<? extends Throwable>[] type() default {RuntimeException.class, 
064                Error.class};
065        
066        RetentionPolicy value() default RetentionPolicy.INVALIDATE;
067    }