com.sun.javafx.runtime.VersionInfo Maven / Gradle / Ivy
/*
* Copyright (c) 2011, 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.javafx.runtime;
/**
* The VersionInfo class contains strings that describe the implementation
* and specification version of the javafx pacakges. These strings
* are made available as properties obtained from the System Properties class.
*
*
* This class serves 3 purposes:
*
* 1. It creates the JavaFX version properties to be added into the Java
* System Properties at the loading of the JavaFX Toolkit. The JavaFX properties
* are javafx.version and javafx.runtime.version. Their formats follow the
* specification of java.version and java.runtime.version respectively.
* See https://openjdk.org/jeps/223 for details.
*
* For example, an early access build of JavaFX 9 build 76 will contain
* the following properties:
*
* javafx.version = 9-ea
* javafx.runtime.version = 9-ea+76
*
* An fcs build of JavaFX 9 build 135 will contain the following properties:
*
* javafx.version = 9
* javafx.runtime.version = 9+135
*
* 2. It provides methods to access Hudson build information and timestamp.
* These methods can be used to uniquely identify a particular build
* for internal test and deployment:
*
* The method getHudsonJobName() returns the name of the Hudson job.
* An empty string is returned if the build isn't built on Hudson, such as a
* local build on a developer machine.
*
* The method getHudsonBuildNumber() returns the number of the Hudson build
* for a particular job.
* A string of zeros is returned if the build isn't built on Hudson, such as a
* local build on a developer machine.
*
* The method getBuildTimestamp() will returns the timestamp of the build.
*
* 3. To uniquely identify a build that isn't generated on Hudson, such as a
* local build on a developer machine. It substitutes the build number tag of
* the javafx.runtime.version string with the build timestamp.
* For example, a build of JavaFX 9 on a developer machine will look
* something like the following:
*
* javafx.version = 9-internal
* javafx.runtime.version = 9-internal+0-2015-08-10_22-08-04
*
*
* The tags of the form @STRING@ are populated by ant when the project is built
*
* @see System#getProperties
*/
public class VersionInfo {
/**
* Build Timestamp.
*/
private static final String BUILD_TIMESTAMP = "2024-09-16-094918";
/**
* Hudson Job Name.
*/
private static final String HUDSON_JOB_NAME = "OpenJFX-build";
/**
* Hudson Build Number.
*/
private static final String HUDSON_BUILD_NUMBER = "154";
/**
* Release suffix.
*/
private static final String RELEASE_SUFFIX = "";
/**
* The composite version string.
*/
private static final String VERSION = "23";
/**
* The composite version string include build number.
*/
private static final String RUNTIME_VERSION = "23+29";
/**
* Setup the System properties with JavaFX API version information.
* The format of the value strings of javafx.version and javafx.runtime.version
* will follow the same pattern as java.version and java.runtime.version
* respectively.
* See https://openjdk.org/jeps/223 for details.
*/
public static synchronized void setupSystemProperties() {
if (System.getProperty("javafx.version") == null) {
System.setProperty("javafx.version", getVersion());
System.setProperty("javafx.runtime.version", getRuntimeVersion());
}
}
/**
* Returns the build timestamp of the JavaFx API.
* @return the build timestamp of the JavaFX API
*/
public static String getBuildTimestamp() {
return BUILD_TIMESTAMP;
}
/**
* Returns the Hudson job name, an empty string is return if HUNDSON_JOB_NAME
* is set to "not_hudson".
* @return the Hudson job name
*/
public static String getHudsonJobName() {
if (HUDSON_JOB_NAME.equals("not_hudson")) {
return "";
}
return HUDSON_JOB_NAME;
}
/**
* Returns the Hudson build number.
* @return the Hudson build number
*/
public static String getHudsonBuildNumber() {
return HUDSON_BUILD_NUMBER;
}
/**
* Returns the release milestone string by stripping off the leading '-'
* from the RELEASE_SUFFIX if present.
* Note: RELEASE_SUFFIX is expected to be empty for fcs versions
*
* @return the release milestone string
*/
public static String getReleaseMilestone() {
String str = RELEASE_SUFFIX;
if (str.startsWith("-")) {
str = str.substring(1);
}
return str;
}
/**
* Returns the version string.
* @return the version string
*/
public static String getVersion() {
return VERSION;
}
/**
* Returns the runtime version string.
* @return the runtime version string
*/
public static String getRuntimeVersion() {
return RUNTIME_VERSION;
}
}