org.opengis.geometry.coordinate.BSplineSurfaceForm 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.geometry.coordinate;

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;

/**
 * Indicates a particular geometric form represented by a {@link BSplineSurface}.
 *
 * @version ISO 19107
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 2.1
 */
@UML(identifier = "GM_BSplineSurfaceForm", specification = ISO_19107)
public class BSplineSurfaceForm extends CodeList {
    /** Serial number for compatibility with different versions. */
    private static final long serialVersionUID = -5066463171878030795L;

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

    /**
     * A bounded portion of a plane represented by a B-spline surface of degree 1 in each parameter.
     */
    @UML(identifier = "planar", obligation = CONDITIONAL, specification = ISO_19107)
    public static final BSplineSurfaceForm PLANAR = new BSplineSurfaceForm("PLANAR");

    /** A bounded portion of a cylindrical surface represented by a B-spline surface. */
    @UML(identifier = "cylindrical", obligation = CONDITIONAL, specification = ISO_19107)
    public static final BSplineSurfaceForm CYLINDRICAL = new BSplineSurfaceForm("CYLINDRICAL");

    /**
     * A bounded portion of the surface of a right circular cone represented by a B-spline surface.
     */
    @UML(identifier = "conical", obligation = CONDITIONAL, specification = ISO_19107)
    public static final BSplineSurfaceForm CONICAL = new BSplineSurfaceForm("CONICAL");

    /** A bounded portion of a sphere, or a complete sphere represented by a B-spline surface. */
    @UML(identifier = "spherical", obligation = CONDITIONAL, specification = ISO_19107)
    public static final BSplineSurfaceForm SPHERICAL = new BSplineSurfaceForm("SPHERICAL");

    /** A torus or a portion of a torus represented by a B-spline surface. */
    @UML(identifier = "toroidal", obligation = CONDITIONAL, specification = ISO_19107)
    public static final BSplineSurfaceForm TOROIDAL = new BSplineSurfaceForm("TOROIDAL");

    /** No particular surface is specified.. */
    @UML(identifier = "unspecified", obligation = CONDITIONAL, specification = ISO_19107)
    public static final BSplineSurfaceForm UNSPECIFIED = new BSplineSurfaceForm("UNSPECIFIED");

    /**
     * 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 BSplineSurfaceForm(final String name) {
        super(name, VALUES);
    }

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

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

    /**
     * Returns the B-spline surface form 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 BSplineSurfaceForm valueOf(String code) {
        return valueOf(BSplineSurfaceForm.class, code);
    }
}