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>Applied to static methods or static fields to denote a factory.</p>
040     *
041     * <p><h3>Constructor Constraints</h3>
042     * The constructor on which the {@code StaticFactory} annotation is applied MUST fulfill all
043     * of the following criteria:
044     * <ul>
045     * <li>The constructor MUST NOT have any parameters.
046     * <li>The constructor MAY throw a checked exception.
047     * <li>The constructor on which {@code StaticFactory} is applied MAY be {@code public},
048     * {@code protected}, package private or {@code private}.
049     * </ul>
050     * </p>
051     * <p><h3>Method Constraints</h3>
052     * The method on which the {@code StaticFactory} annotation is applied MUST fulfill all
053     * of the following criteria:
054     * <ul>
055     * <li>The method MUST NOT have any parameters.
056     * <li>The return type of the method MUST NOT be {@code void}.
057     * <li>The method MAY throw a checked exception.
058     * <li>The method on which {@code StaticFactory} is applied MAY be {@code public},
059     * {@code protected}, package private or {@code private}. 
060     * <li>The method MUST be {@code static}.
061     * <li>The method MAY be {@code final}. 
062     * </ul>
063     * </p>
064     * <p><h3>Field Constraints</h3>
065     * The field on which the {@code Factory} annotation is applied MUST fulfill all
066     * of the following criteria:
067     * <ul>
068      * <li>The field on which {@code StaticFactory} is applied MAY be {@code public},
069     * {@code protected}, package private or {@code private}.
070     * <li>The field MUST be {@code static}.
071     * <li>The field MAY be {@code final}.
072     * </ul>
073     * </p>
074     *
075     * {@beanlet.annotation}
076     *
077     * @author Leon van Zantvoort
078     */
079    @Retention(RetentionPolicy.RUNTIME)
080    @Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.FIELD})
081    public @interface StaticFactory {
082    
083    }