001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2005-2013 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.Documented;
036 import java.lang.annotation.Retention;
037 import static java.lang.annotation.ElementType.*;
038 import static java.lang.annotation.RetentionPolicy.*;
039
040
041 /**
042 * Maps an interface or a method to the XML type, element or attribute.
043 * Interfaces usually map to XML types, while methods map to XML element
044 * or attribute. It is not the purpose of this annotation to differentiate
045 * types from attributes, since this distinction can already be inferred from
046 * Java reflection. This annotation, completed with reflection if needed, should
047 * only provides enough information for finding the corresponding XML element in
048 * the {@linkplain XmlSchema schema}.
049 *
050 * @author Martin Desruisseaux (IRD)
051 * @since GeoAPI 2.0
052 */
053 @Documented
054 @Target({TYPE,METHOD,FIELD})
055 @Retention(RUNTIME)
056 public @interface XmlElement {
057 /**
058 * The name of the element in the XML schema.
059 *
060 * @return The XML element name.
061 */
062 String value();
063 }