org.eclipse.persistence.jpa.rs.features.ServiceVersion Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation

EclipseLink build based upon Git transaction f2b9fc5

There is a newer version: 5.0.0-B03

/*
 * Copyright (c) 2014, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//      Dmitry Kornilov - initial implementation
package org.eclipse.persistence.jpa.rs.features;

import java.util.HashMap;
import java.util.Map;

/**
 * JPARS service version.
 *
 * @author Dmitry Kornilov
 * @since EclipseLink 2.6.0
 */
public enum ServiceVersion {

    /**
     * Version 1.0. Legacy.
     */
    VERSION_1_0("v1.0"),

    /**
     * Version 2.0. Supports pagination and other new features.
     */
    VERSION_2_0("v2.0"),

    /**
     * The latest version.
     */
    LATEST("latest");

    /**
     * String representation of the version number. As it appears in the URL. Ex. "v2.0"
     */
    private final String version;

    private static final Map values;

    static {
        values = new HashMap<>();
        for (final ServiceVersion e : ServiceVersion.values()) {
            values.put(e.getCode(), e);
        }
    }

    private ServiceVersion(final String version) {
        this.version = version;
    }

    /**
     * Returns the version as in appears in URI.
     *
     * @return the version.
     */
    public String getCode() {
        return version;
    }

    /**
     * Returns enumeration value by version number as it appears in URI.
     *
     * @param version version as it appears in URI.
     * @return ServiceVersion.
     * @throws IllegalArgumentException in case that the passed code does not match any enumeration value.
     */
    public static ServiceVersion fromCode(final String version) throws IllegalArgumentException {
        final ServiceVersion e = values.get(version);
        if (e == null) {
            throw new IllegalArgumentException("Unsupported version " + version);
        }
        return e;
    }

    /**
     * Gets a {@link FeatureSet} related to this service version.
     *
     * @return {@link FeatureSet} related to this version.
     */
    public FeatureSet getFeatureSet() {
        if (this.compareTo(VERSION_2_0) < 0) {
            return new FeatureSetPreV2();
        }
        return new FeatureSetV2();
    }

    /**
     * Checks if ServiceVersion with given code exists.
     *
     * @param code Code to check.
     * @return true if exists, false if not.
     */
    public static boolean hasCode(String code) {
        return values.containsKey(code);
    }
}