001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2005-2012 Open Geospatial Consortium, Inc.
006     *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007     *
008     *    Permission to use, copy, and modify this software and its documentation, with
009     *    or without modification, for any purpose and without fee or royalty is hereby
010     *    granted, provided that you include the following on ALL copies of the software
011     *    and documentation or portions thereof, including modifications, that you make:
012     *
013     *    1. The full text of this NOTICE in a location viewable to users of the
014     *       redistributed or derivative work.
015     *    2. Notice of any changes or modifications to the OGC files, including the
016     *       date changes were made.
017     *
018     *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019     *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020     *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021     *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022     *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023     *
024     *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025     *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026     *
027     *    The name and trademarks of copyright holders may NOT be used in advertising or
028     *    publicity pertaining to the software without specific, written prior permission.
029     *    Title to copyright in this software and any associated documentation will at all
030     *    times remain with copyright holders.
031     */
032    package org.opengis.annotation;
033    
034    import java.lang.annotation.Target;
035    import java.lang.annotation.Retention;
036    import java.lang.annotation.Documented;
037    import static java.lang.annotation.ElementType.*;
038    import static java.lang.annotation.RetentionPolicy.*;
039    
040    
041    /**
042     * An annotation mapping each interface, methods or fields to
043     * the UML identifier where they come from.
044     *
045     * @author  Martin Desruisseaux (IRD)
046     * @version 3.0
047     * @since   2.0
048     *
049     * @navassoc - - - String
050     * @navassoc - - - Obligation
051     * @navassoc - - - Specification
052     */
053    @Documented
054    @Retention(RUNTIME)
055    @Target({TYPE, FIELD, METHOD})
056    public @interface UML {
057        /**
058         * The UML identifier for the annotated interface, method or code list element.
059         * Scripts can use this identifier in order to maps a GeoAPI method to the UML
060         * entity where it come from.
061         *
062         * @return The UML identifier used in the standard.
063         */
064        String identifier();
065    
066        /**
067         * The obligation declared in the UML. This metadata can be queried in order to
068         * determine if a null value is allowed for the annotated method or not. If the
069         * obligation is {@link Obligation#MANDATORY}, then null value are not allowed.
070         *
071         * @return The obligation declared in the standard.
072         */
073        Obligation obligation() default Obligation.MANDATORY;
074    
075        /**
076         * The specification where this UML come from.
077         *
078         * @return The originating specification.
079         */
080        Specification specification();
081    }