admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

language/java: document public API

Browse Source
This commit is contained in:
Michael Cho 2024-10-17 12:03:10 -04:00
parent 1fdbc6fe5a
commit 372e8fb4b7
No known key found for this signature in database
GPG Key ID: 55E85E28A7CD1E85
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Library/Homebrew/language/java.rb
View File

@ -28,6 +28,13 @@ module Language
end
private_class_method :find_openjdk_formula
# Returns the directory of the newest matching OpenJDK installation or
# `nil` if none is available. When used in a {Formula}, there should be
# a dependency and corresponding `version` for reproducible output.
#
# @api public
# @param version OpenJDK version constraint which can be specific
# (e.g. `"21"`) or a lower-bounded range (e.g. `"21+"`)
sig { params(version: T.nilable(String)).returns(T.nilable(Pathname)) }
def self.java_home(version = nil)
find_openjdk_formula(version)&.opt_libexec
@ -39,11 +46,36 @@ module Language
end
private_class_method :java_home_shell
# Returns a `JAVA_HOME` environment variable to use a specific OpenJDK.
# Usually combined with either {Pathname#write_env_script} or
# {Pathname#env_script_all_files}.
#
# ### Example
#
# Use `openjdk@21` for all commands:
#
# ```ruby
# bin.env_script_all_files libexec/"bin", Language::Java.java_home_env("21")
# ```
#
# @api public
sig { params(version: T.nilable(String)).returns({ JAVA_HOME: String }) }
def self.java_home_env(version = nil)
{ JAVA_HOME: java_home_shell(version) }
end
# Returns a `JAVA_HOME` environment variable to use a default OpenJDK.
# Unlike {.java_home_env} the OpenJDK can be overridden at runtime.
#
# ### Example
#
# Use latest `openjdk` as default:
#
# ```ruby
# bin.env_script_all_files libexec/"bin", Language::Java.overridable_java_home_env
# ```
#
# @api public
sig { params(version: T.nilable(String)).returns({ JAVA_HOME: String }) }
def self.overridable_java_home_env(version = nil)
{ JAVA_HOME: "${JAVA_HOME:-#{java_home_shell(version)}}" }