OrekitConfiguration.java

/* Copyright 2002-2025 CS GROUP
 * Licensed to CS GROUP (CS) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * CS licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.orekit.utils;

import org.hipparchus.util.MathUtils;

import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;

/** Utility class for setting global configuration parameters.

 * @author Luc Maisonobe
 */
public class OrekitConfiguration {

    /** Number of slots to use in caches. */
    private static int CACHE_SLOTS_NUMBER;

    static {
        CACHE_SLOTS_NUMBER = 100;
    }

    /** Private constructor.
     * <p>This class is a utility class, it should neither have a public
     * nor a default constructor. This private constructor prevents
     * the compiler from generating one automatically.</p>
     */
    private OrekitConfiguration() {
    }

    /** Set the number of slots to use in caches.
     * @param slotsNumber number of slots to use in caches
     */
    public static void setCacheSlotsNumber(final int slotsNumber) {
        OrekitConfiguration.CACHE_SLOTS_NUMBER = slotsNumber;
    }

    /** Get the number of slots to use in caches.
     * @return number of slots to use in caches
     */
    public static int getCacheSlotsNumber() {
        return CACHE_SLOTS_NUMBER;
    }

    /**
     * Get Orekit version.
     * <p>
     * The version is automatically retrieved from a properties file generated
     * at maven compilation time. When using an IDE not configured to use
     * maven, then a default value {@code "unknown"} will be returned.
     * </p>
     * @return Orekit version
     * @since 4.0
     */
    public static String getOrekitVersion() {
        String version = "unknown";
        final Properties properties = new Properties();
        try (InputStream stream = MathUtils.class.getResourceAsStream("/assets/org/orekit/orekit.properties")) {
            if (stream != null) {
                properties.load(stream);
                version = properties.getProperty("orekit.version", version);
            }
        } catch (IOException ioe) {
            // ignored
        }
        return version;
    }

}