org.opengis.referencing.cs.RangeMeaning Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gt-opengis Show documentation
Standard interfaces implemented throughout the library.
There is a newer version: 24.2-oss84-1
/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2003-2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.referencing.cs;

import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;

import java.util.ArrayList;
import java.util.List;
import org.opengis.annotation.UML;
import org.opengis.util.CodeList;

/**
 * Meaning of the axis value range specified through {@linkplain
 * CoordinateSystemAxis#getMinimumValue minimum value} and {@linkplain
 * CoordinateSystemAxis#getMaximumValue maximum value}.
 *
 * @version Abstract
 *     specification 2.0
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 2.1
 * @see CoordinateSystemAxis#getRangeMeaning
 */
@UML(identifier = "CS_RangeMeaning", specification = ISO_19111)
public final class RangeMeaning extends CodeList {
    /** Serial number for compatibility with different versions. */
    private static final long serialVersionUID = -3525560558294789416L;

    /** List of all enumerations of this type. Must be declared before any enum declaration. */
    private static final List VALUES = new ArrayList(2);

    /**
     * Any value between and including {@linkplain CoordinateSystemAxis#getMinimumValue minimum
     * value} and {@linkplain CoordinateSystemAxis#getMaximumValue maximum value} is valid.
     */
    @UML(identifier = "exact", obligation = CONDITIONAL, specification = ISO_19111)
    public static final RangeMeaning EXACT = new RangeMeaning("EXACT");

    /**
     * The axis is continuous with values wrapping around at the {@linkplain
     * CoordinateSystemAxis#getMinimumValue minimum value} and {@linkplain
     * CoordinateSystemAxis#getMaximumValue maximum value}. Values with the same meaning repeat
     * modulo the difference between maximum value and minimum value.
     */
    @UML(identifier = "wraparound", obligation = CONDITIONAL, specification = ISO_19111)
    public static final RangeMeaning WRAPAROUND = new RangeMeaning("WRAPAROUND");

    /**
     * Constructs an enum with the given name. The new enum is automatically added to the list
     * returned by {@link #values}.
     *
     * @param name The enum name. This name must not be in use by an other enum of this type.
     */
    private RangeMeaning(final String name) {
        super(name, VALUES);
    }

    /**
     * Returns the list of {@code RangeMeaning}s.
     *
     * @return The list of codes declared in the current JVM.
     */
    public static RangeMeaning[] values() {
        synchronized (VALUES) {
            return VALUES.toArray(new RangeMeaning[VALUES.size()]);
        }
    }

    /** Returns the list of enumerations of the same kind than this enum. */
    public RangeMeaning[] family() {
        return values();
    }

    /**
     * Returns the range meaning that matches the given string, or returns a new one if none match
     * it.
     *
     * @param code The name of the code to fetch or to create.
     * @return A code matching the given name.
     */
    public static RangeMeaning valueOf(String code) {
        return valueOf(RangeMeaning.class, code);
    }
}