Version.java

/*
 * *************************************************************************************************************************************************************
 *
 * MapView: a JavaFX map renderer for tile-based servers
 * http://tidalwave.it/projects/mapview
 *
 * Copyright (C) 2024 - 2026 by Tidalwave s.a.s. (http://tidalwave.it)
 *
 * *************************************************************************************************************************************************************
 *
 * Licensed 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.
 *
 * *************************************************************************************************************************************************************
 *
 * git clone https://bitbucket.org/tidalwave/mapview-src
 * git clone https://github.com/tidalwave-it/mapview-src
 *
 * *************************************************************************************************************************************************************
 */
package it.tidalwave.mapview.impl;

import jakarta.annotation.Nonnull;
import java.util.Objects;
import java.util.Properties;
import java.io.IOException;
import java.io.UncheckedIOException;
import lombok.experimental.UtilityClass;
import lombok.extern.slf4j.Slf4j;

/***************************************************************************************************************************************************************
 *
 * Provides the version of this library, as injected by Maven in a filtered resource.
 *
 * @author  Fabrizio Giudici
 *
 **************************************************************************************************************************************************************/
@UtilityClass @Slf4j
public class Version
  {
    private static final String RESOURCE = "version.properties";

    private static final String VERSION = load();

    /***********************************************************************************************************************************************************
     * {@return the version of this library, or an empty value if it is not available (e.g. the resource has not been filtered)}.
     **********************************************************************************************************************************************************/
    @Nonnull
    public static String get()
      {
        return VERSION;
      }

    /***********************************************************************************************************************************************************
     * {@return the version read from the resource}.
     **********************************************************************************************************************************************************/
    @Nonnull
    private static String load()
      {
        try (final var is = Version.class.getResourceAsStream(RESOURCE))
          {
            Objects.requireNonNull(is, "Resource not found");
            final var properties = new Properties();
            properties.load(is);
            return properties.getProperty("version").trim();
          }
        catch (IOException e)
          {
            throw new UncheckedIOException("Cannot read resource", e);
          }
      }
  }