001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2004-2023 Open Geospatial Consortium, Inc.
004 *    http://www.geoapi.org
005 *
006 *    Licensed under the Apache License, Version 2.0 (the "License");
007 *    you may not use this file except in compliance with the License.
008 *    You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *    Unless required by applicable law or agreed to in writing, software
013 *    distributed under the License is distributed on an "AS IS" BASIS,
014 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 *    See the License for the specific language governing permissions and
016 *    limitations under the License.
017 */
018package org.opengis.metadata;
019
020import org.opengis.util.CodeList;
021import org.opengis.annotation.UML;
022import org.opengis.geoapi.internal.Vocabulary;
023
024import static org.opengis.annotation.Specification.*;
025
026
027/**
028 * Obligation of the element or entity.
029 *
030 * <div class="warning"><b>Upcoming API change — enumeration</b><br>
031 * According ISO 19115, {@code Obligation} shall be an enumeration, not a code list.
032 * Such enumeration already exists in the {@link org.opengis.annotation} package.
033 * Consequently this {@code Obligation} class may be deleted in favor or {@code org.opengis.annotation.Obligation}
034 * in GeoAPI 4.0. See <a href="http://jira.codehaus.org/browse/GEO-199">GEO-199</a> for more information.</div>
035 *
036 * @author  Martin Desruisseaux (IRD)
037 * @version 3.1
038 * @since   2.0
039 */
040@Vocabulary(capacity=3)
041@UML(identifier="MD_ObligationCode", specification=ISO_19115)
042public final class Obligation extends CodeList<Obligation> {
043    /**
044     * Serial number for compatibility with different versions.
045     */
046    private static final long serialVersionUID = -2135167450448770693L;
047
048    /**
049     * Element is always required.
050     */
051    @UML(identifier="mandatory", obligation=org.opengis.annotation.Obligation.CONDITIONAL, specification=ISO_19115)
052    public static final Obligation MANDATORY = new Obligation("MANDATORY");
053
054    /**
055     * Element is not required.
056     */
057    @UML(identifier="optional", obligation=org.opengis.annotation.Obligation.CONDITIONAL, specification=ISO_19115)
058    public static final Obligation OPTIONAL = new Obligation("OPTIONAL");
059
060    /**
061     * Element is required when a specific condition is met.
062     */
063    @UML(identifier="conditional", obligation=org.opengis.annotation.Obligation.CONDITIONAL, specification=ISO_19115)
064    public static final Obligation CONDITIONAL = new Obligation("CONDITIONAL");
065
066    /**
067     * Constructs an element of the given name.
068     *
069     * @param name The name of the new element.
070     *        This name must not be in use by an other element of this type.
071     */
072    private Obligation(final String name) {
073        super(name);
074    }
075
076    /**
077     * Returns the list of {@code Obligation}s.
078     *
079     * @return The list of codes declared in the current JVM.
080     */
081    public static Obligation[] values() {
082        return values(Obligation.class);
083    }
084
085    /**
086     * Returns the list of codes of the same kind than this code list element.
087     * Invoking this method is equivalent to invoking {@link #values()}, except that
088     * this method can be invoked on an instance of the parent {@code CodeList} class.
089     *
090     * @return All code {@linkplain #values() values} for this code list.
091     */
092    @Override
093    public Obligation[] family() {
094        return values();
095    }
096
097    /**
098     * Returns the obligation that matches the given string, or returns a new one if none match it.
099     * This methods returns the first instance (in declaration order) for which the {@linkplain #name() name}
100     * is {@linkplain String#equalsIgnoreCase(String) equals, ignoring case}, to the given name.
101     * If no existing instance is found, then a new one is created for the given name.
102     *
103     * @param code The name of the code to fetch or to create.
104     * @return A code matching the given name.
105     */
106    public static Obligation valueOf(String code) {
107        return valueOf(Obligation.class, code, Obligation::new).get();
108    }
109}