001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2003-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.parameter;
019
020import org.opengis.annotation.UML;
021import org.opengis.annotation.Classifier;
022import org.opengis.annotation.Stereotype;
023
024import static org.opengis.annotation.Obligation.*;
025import static org.opengis.annotation.Specification.*;
026
027
028/**
029 * Abstract parameter value or group of parameter values.
030 *
031 * @author  OGC Topic 2 (for abstract model and documentation)
032 * @author  Martin Desruisseaux (IRD, Geomatys)
033 * @author  Jody Garnett (Refractions Research)
034 * @version 3.1
035 * @since   1.0
036 *
037 * @see GeneralParameterDescriptor
038 */
039@Classifier(Stereotype.ABSTRACT)
040@UML(identifier="GeneralParameterValue", specification=ISO_19111)
041public interface GeneralParameterValue {
042    /**
043     * Returns the abstract definition of this parameter or group of parameters.
044     *
045     * @return the abstract definition of this parameter or group of parameters.
046     */
047    @UML(identifier="parameter", obligation=MANDATORY, specification=ISO_19111)
048    GeneralParameterDescriptor getDescriptor();
049
050    /**
051     * Returns a copy of this parameter value or group.
052     *
053     * @return a copy of this parameter value or group.
054     */
055    GeneralParameterValue clone();
056}