View Javadoc
1   /*
2    * Logback: the reliable, generic, fast and flexible logging framework.
3    * Copyright (C) 1999-2026, QOS.ch. All rights reserved.
4    *
5    * This program and the accompanying materials are dual-licensed under
6    * either the terms of the Eclipse Public License v2.0 as published by
7    * the Eclipse Foundation
8    *
9    *   or (per the licensee's choosing)
10   *
11   * under the terms of the GNU Lesser General Public License version 2.1
12   * as published by the Free Software Foundation.
13   */
14  
15  package ch.qos.logback.core.util;
16  
17  import ch.qos.logback.core.CoreConstants;
18  
19  import java.io.IOException;
20  import java.io.InputStream;
21  import java.util.Properties;
22  
23  /**
24   * Utility class for retrieving version information of the "logback-core" module.
25   *
26   * @since 1.5.26
27   */
28  public class CoreVersionUtil {
29  
30      static String CORE_MODULE_NAME = "logback-core";
31      static String CORE_MODULE_VERSION_PROPERTIES_FILE = CORE_MODULE_NAME + "-version.properties";
32      static String CORE_MODULE_VERSION_PROPERTY_KEY = CORE_MODULE_NAME + "-version";
33  
34      /**
35       * Retrieves the version of the "logback-core" module using a properties file
36       * associated with the module.
37       *
38       * <p>The method locates and reads a properties file named "logback-core-version.properties"
39       * in the package of the {@code CoreConstants.class}. It then extracts the version
40       * information using the key "logback-core-version".
41       * </p>
42       *
43       * @return the version of the "logback-core" module as a string, or null if the version cannot be determined
44       * @since 1.5.26
45       */
46      static public String getCoreVersionBySelfDeclaredProperties() {
47          Properties props = new Properties();
48  
49          try (InputStream is = CoreConstants.class.getResourceAsStream(CORE_MODULE_VERSION_PROPERTIES_FILE)) {
50              if (is != null) {
51                  props.load(is);
52                  return props.getProperty(CORE_MODULE_VERSION_PROPERTY_KEY);
53              } else {
54                  return null;
55              }
56          } catch (IOException e) {
57              return null;
58          }
59      }
60  }