Index (jdkprovidergradleplugin 0.7.0-beta3 API)

A B C D E F G H I J L M N O P Q R S T V W X
All Classes and Interfaces|All Packages

A

AARCH32 - Enum constant in enum class com.dua3.gradle.jdkprovider.types.SystemArchitecture: Represents the AARCH32 system architecture, also known as ARM 32-bit architecture.
AARCH64 - Enum constant in enum class com.dua3.gradle.jdkprovider.types.SystemArchitecture: Represents the 64-bit ARM architecture, commonly known as `aarch64` or `arm64`.
AIX - Enum constant in enum class com.dua3.gradle.jdkprovider.types.OSFamily: Represents the AIX operating system family.
aliases() - Method in enum class com.dua3.gradle.jdkprovider.types.SystemArchitecture: Retrieves the list of alias names associated with the system architecture.
any() - Static method in class com.dua3.gradle.jdkprovider.types.VersionSpec: Creates a VersionSpec instance that matches any version.
apply(Project) - Method in class com.dua3.gradle.jdkprovider.plugin.JdkProviderPlugin: Apply the plugin to the project as described in the plugin class description.
arch() - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Returns the value of the arch record component.
arch() - Method in record class com.dua3.gradle.jdkprovider.types.JdkSpec: Returns the value of the arch record component.
architecture() - Method in record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Returns the value of the architecture record component.
ArchiveExtractor - Class in com.dua3.gradle.jdkprovider.provision: Extracts archives supported for typical JDK packages: .zip and .tar.gz
archiveType() - Method in record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Returns the value of the archiveType record component.

B

blacklist(URI) - Method in class com.dua3.gradle.jdkprovider.provision.JdkProvisioner: Blacklists a download URI to avoid redownloading it in the future.

C

ChecksumUtil - Class in com.dua3.gradle.jdkprovider.provision: Utility class for calculating and verifying SHA-256 file checksums.
com.dua3.gradle.jdkprovider.disco - package com.dua3.gradle.jdkprovider.disco
com.dua3.gradle.jdkprovider.local - package com.dua3.gradle.jdkprovider.local
com.dua3.gradle.jdkprovider.plugin - package com.dua3.gradle.jdkprovider.plugin
com.dua3.gradle.jdkprovider.provision - package com.dua3.gradle.jdkprovider.provision
com.dua3.gradle.jdkprovider.resolver - package com.dua3.gradle.jdkprovider.resolver
com.dua3.gradle.jdkprovider.types - package com.dua3.gradle.jdkprovider.types
createDiscoApiClient() - Method in class com.dua3.gradle.jdkprovider.resolver.JdkResolver
createJdkProvisioner() - Method in class com.dua3.gradle.jdkprovider.resolver.JdkResolver
createLocalJdkScanner() - Method in class com.dua3.gradle.jdkprovider.resolver.JdkResolver
current() - Static method in enum class com.dua3.gradle.jdkprovider.types.OSFamily: Determines the current operating system based on the system property "os.name".
current() - Static method in enum class com.dua3.gradle.jdkprovider.types.SystemArchitecture: Returns the current system architecture based on the `os.arch` system property.
current() - Static method in class com.dua3.gradle.jdkprovider.types.VersionSpec: Retrieves the current runtime version and constructs a VersionSpec object representing the major, minor, patch, and build versions.

D

detectJdkHome(Path) - Static method in class com.dua3.gradle.jdkprovider.local.LocalJdkScanner: Detects the home directory of a JDK installation by analyzing the given extracted root directory.
DiscoApiClient - Class in com.dua3.gradle.jdkprovider.disco: DiscoAPI client to discover Disco packages.
DiscoApiClient() - Constructor for class com.dua3.gradle.jdkprovider.disco.DiscoApiClient: Constructs a new instance of DiscoApiClient with the default base URL.
DiscoApiClient(String) - Constructor for class com.dua3.gradle.jdkprovider.disco.DiscoApiClient: Constructs a new instance of DiscoApiClient with the specified base URL.
DiscoPackage - Record Class in com.dua3.gradle.jdkprovider.types: Represents a package containing information about a downloadable asset, such as its URI, checksum, distribution details, archive type, and compatibility with a specific operating system and architecture.
DiscoPackage(URI, String, String, String, String, Runtime.Version, OSFamily, SystemArchitecture, String) - Constructor for record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Creates an instance of a DiscoPackage record class.
distribution() - Method in record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Returns the value of the distribution record component.
downloadTo(URI, Path) - Method in class com.dua3.gradle.jdkprovider.provision.HttpDownloader: Downloads the content from the specified URI to the target file path.
downloadUri() - Method in record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Returns the value of the downloadUri record component.

E

equals(Object) - Method in record class com.dua3.gradle.jdkprovider.local.JdkInstallation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.dua3.gradle.jdkprovider.types.JdkSpec: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.dua3.gradle.jdkprovider.types.VersionSpec
extract(Path, Path) - Static method in class com.dua3.gradle.jdkprovider.provision.ArchiveExtractor: Extracts the specified archive file into the target directory.

F

filename() - Method in record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Returns the value of the filename record component.
findPackage(JdkQuery) - Method in class com.dua3.gradle.jdkprovider.disco.DiscoApiClient: Finds a suitable DiscoPackage based on the provided JdkQuery.
findPackages(JdkQuery) - Method in class com.dua3.gradle.jdkprovider.disco.DiscoApiClient: Finds all suitable DiscoPackages based on the provided JdkQuery, sorted from most preferred to least preferred.
FREE_BSD - Enum constant in enum class com.dua3.gradle.jdkprovider.types.OSFamily: Represents the FreeBSD operating system family.
freeForProductionUseOnly() - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Returns the value of the freeForProductionUseOnly record component.

G

getArch() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Retrieves the system architecture configuration property.
getArch() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkSpecOverride: Retrieves the property representing the system architecture configuration.
getAutomaticDownload() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Retrieves the property indicating whether automatic download of the JDK is enabled.
getCacheDir() - Static method in class com.dua3.gradle.jdkprovider.provision.JdkProvisioner: Retrieves the base directory used for caching toolchain data for the Java resolver plugin.
getCachedJdksDir() - Static method in class com.dua3.gradle.jdkprovider.provision.JdkProvisioner: Provides the directory path where cached JDKs are installed.
getCompatibleInstalledJdks(JdkQuery) - Method in class com.dua3.gradle.jdkprovider.local.LocalJdkScanner: Filters the list of installed JDKs to identify those that are compatible based on the provided JdkSpec instance.
getGradleUserHome() - Static method in class com.dua3.gradle.jdkprovider.provision.JdkProvisioner: Determines the location of the Gradle user home directory.
getInstalledJdks() - Method in class com.dua3.gradle.jdkprovider.local.LocalJdkScanner: Try to find JDK homes from typical locations: JAVA_HOME and Gradle's installation paths property.
getJavaFxBundled() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Retrieves the property indicating whether the JavaFX runtime is bundled with the JDK.
getJavaFxBundled() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkSpecOverride: Retrieves the property indicating whether JavaFX is bundled with the JDK.
getJavaLauncher(Project) - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Retrieves a provider for the Java launcher associated with the specified project.
getJdkHome() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Read-only provider for the resolved JDK home directory.
getJdkSpec() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Read-only provider for the resolved JDK version specification.
getName() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkSpecOverride: Retrieves the name of this JDK specification override configuration.
getNativeImageCapable() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Retrieves the property indicating whether the JDK is capable of building native images.
getNativeImageCapable() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkSpecOverride: Retrieves the property indicating whether native image capabilities are supported.
getOs() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Retrieves the property representing the operating system family.
getOs() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkSpecOverride: Retrieves the operating system family property for this configuration.
getOverrides() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Retrieves the container for JDK overrides.
getPackagesQueryUrl(JdkQuery) - Method in class com.dua3.gradle.jdkprovider.disco.DiscoApiClient: Builds and returns the DiscoAPI packages query URL for the provided JDK query.
getVendor() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Retrieves the property representing the vendor specification of the JVM.
getVendor() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkSpecOverride: Returns the property representing the JDK vendor specification.
getVersion() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Retrieves the version of the JDK configured for the extension.
getVersion() - Method in class com.dua3.gradle.jdkprovider.plugin.JdkSpecOverride: Retrieves the version property of this JDK specification override.

H

hashCode() - Method in record class com.dua3.gradle.jdkprovider.local.JdkInstallation: Returns a hash code value for this object.
hashCode() - Method in record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Returns a hash code value for this object.
hashCode() - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Returns a hash code value for this object.
hashCode() - Method in record class com.dua3.gradle.jdkprovider.types.JdkSpec: Returns a hash code value for this object.
hashCode() - Method in class com.dua3.gradle.jdkprovider.types.VersionSpec
HttpDownloader - Class in com.dua3.gradle.jdkprovider.provision: Simple HTTP downloader with timeouts and basic retry for transient failures.
HttpDownloader(int, int, int) - Constructor for class com.dua3.gradle.jdkprovider.provision.HttpDownloader: Constructs an instance of the HttpDownloader class with specified configuration parameters.

I

isBlacklisted(URI) - Method in class com.dua3.gradle.jdkprovider.provision.JdkProvisioner: Checks if a download URI is blacklisted.
isCompatible(JdkSpec, JdkQuery) - Static method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Determines if the specified JdkSpec is compatible with the constraints defined in the JdkQuery.
isFixedFeature() - Method in class com.dua3.gradle.jdkprovider.types.VersionSpec: Determines if this instance refers to a fixed feature only, i.e., represents a single Java feature version with no interim, update, etc fields set.

J

javaFxBundled() - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Returns the value of the javaFxBundled record component.
javaFxBundled() - Method in record class com.dua3.gradle.jdkprovider.types.JdkSpec: Returns the value of the javaFxBundled record component.
JdkExtension - Class in com.dua3.gradle.jdkprovider.plugin: Extension for configuring the JDK selection.
JdkExtension(ObjectFactory) - Constructor for class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Constructs a new JdkExtension instance with properties to configure JDK selection.
jdkHome() - Method in record class com.dua3.gradle.jdkprovider.local.JdkInstallation: Returns the value of the jdkHome record component.
JdkInstallation - Record Class in com.dua3.gradle.jdkprovider.local: Represents the specification of a JDK installation, consisting of the installation path and the JDK specification.
JdkInstallation(Path, JdkSpec) - Constructor for record class com.dua3.gradle.jdkprovider.local.JdkInstallation: Creates an instance of a JdkInstallation record class.
JdkProviderPlugin - Class in com.dua3.gradle.jdkprovider.plugin: A Gradle plugin for managing JDK dependencies in a project.
JdkProviderPlugin() - Constructor for class com.dua3.gradle.jdkprovider.plugin.JdkProviderPlugin: Default constructor.
JdkProvisioner - Class in com.dua3.gradle.jdkprovider.provision: Downloads, verifies, and extracts JDK archives into a managed cache and returns the JDK home path.
JdkProvisioner() - Constructor for class com.dua3.gradle.jdkprovider.provision.JdkProvisioner: Default constructor for the JdkProvisioner class.
JdkQuery - Record Class in com.dua3.gradle.jdkprovider.types: Represents a query interface for specifying requirements or characteristics of a JDK in terms of operating system, architecture, vendor, and additional configurations such as support for native images and JavaFX.
JdkQuery(OSFamily, SystemArchitecture, Boolean, Boolean, VersionSpec, Boolean, Boolean, Boolean, JvmVendorSpec, String) - Constructor for record class com.dua3.gradle.jdkprovider.types.JdkQuery: Initializes the query with defaults for unspecified attributes.
JdkResolver - Class in com.dua3.gradle.jdkprovider.resolver: Resolves a JDK installation that matches the specified requirements.
JdkResolver() - Constructor for class com.dua3.gradle.jdkprovider.resolver.JdkResolver: Constructs a new instance of the JdkResolver.
jdkSpec() - Method in record class com.dua3.gradle.jdkprovider.local.JdkInstallation: Returns the value of the jdkSpec record component.
JdkSpec - Record Class in com.dua3.gradle.jdkprovider.types: Represents specifications for a JDK.
JdkSpec(OSFamily, SystemArchitecture, Runtime.Version, String, boolean, boolean) - Constructor for record class com.dua3.gradle.jdkprovider.types.JdkSpec: Creates an instance of a JdkSpec record class.
JdkSpecOverride - Class in com.dua3.gradle.jdkprovider.plugin: Configuration for a specific JDK.
JdkSpecOverride(String, ObjectFactory) - Constructor for class com.dua3.gradle.jdkprovider.plugin.JdkSpecOverride: Constructs an instance of JdkSpecOverride with the specified name and object factory.

L

latest() - Static method in class com.dua3.gradle.jdkprovider.types.VersionSpec: Creates a VersionSpec instance representing the latest version.
latestLts() - Static method in class com.dua3.gradle.jdkprovider.types.VersionSpec: Returns a VersionSpec instance representing the latest Long-Term Support (LTS) version.
libcType() - Method in record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Returns the value of the libcType record component.
libcType() - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Returns the value of the libcType record component.
LINUX - Enum constant in enum class com.dua3.gradle.jdkprovider.types.OSFamily: Represents the Linux operating system family.
LocalJdkScanner - Class in com.dua3.gradle.jdkprovider.local: Scans the local machine for JDK installations.
LocalJdkScanner() - Constructor for class com.dua3.gradle.jdkprovider.local.LocalJdkScanner: Constructs a new instance of LocalJdkScanner.
LocalJdkScanner(Map<String, String>, Path) - Constructor for class com.dua3.gradle.jdkprovider.local.LocalJdkScanner: Constructs a new instance of LocalJdkScanner with a custom environment and cache directory.
longTermSupportOnly() - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Returns the value of the longTermSupportOnly record component.

M

MACOS - Enum constant in enum class com.dua3.gradle.jdkprovider.types.OSFamily: Represents the macOS family of operating systems.
matches(Runtime.Version) - Method in class com.dua3.gradle.jdkprovider.types.VersionSpec: Determines if the specified runtime version falls within the range defined by the current VersionSpec instance.
min() - Method in class com.dua3.gradle.jdkprovider.types.VersionSpec: Retrieves the minimum runtime version specified by this VersionSpec.

N

nativeImageCapable() - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Returns the value of the nativeImageCapable record component.
nativeImageCapable() - Method in record class com.dua3.gradle.jdkprovider.types.JdkSpec: Returns the value of the nativeImageCapable record component.

O

of(Runtime.Version) - Static method in class com.dua3.gradle.jdkprovider.types.VersionSpec: Creates a VersionSpec instance based on the specified runtime version.
os() - Method in record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Returns the value of the os record component.
os() - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Returns the value of the os record component.
os() - Method in record class com.dua3.gradle.jdkprovider.types.JdkSpec: Returns the value of the os record component.
OSFamily - Enum Class in com.dua3.gradle.jdkprovider.types: Enum representing various families of operating systems.

P

parse(String) - Static method in enum class com.dua3.gradle.jdkprovider.types.OSFamily: Parses the provided operating system name into an OSFamily instance.
parse(String) - Static method in enum class com.dua3.gradle.jdkprovider.types.SystemArchitecture: Parses the input string representing an operating system architecture and returns the corresponding SystemArchitecture enumeration value.
parse(String) - Static method in class com.dua3.gradle.jdkprovider.types.VersionSpec: Parses a string representation of a version specification.
provision(URI, String, String, String) - Method in class com.dua3.gradle.jdkprovider.provision.JdkProvisioner: Provisions a JDK by downloading, verifying, and extracting the archive from a given URI.
provisionPackage(DiscoPackage) - Method in class com.dua3.gradle.jdkprovider.resolver.JdkResolver

Q

QNX - Enum constant in enum class com.dua3.gradle.jdkprovider.types.OSFamily: Represents the QNX operating system family.

R

readJdkSpec(Path) - Static method in class com.dua3.gradle.jdkprovider.local.LocalJdkScanner: Attempts to read the JDK spec by reading the release file.
readJdkSpec(Path) - Method in class com.dua3.gradle.jdkprovider.resolver.JdkResolver
removeExtractedJdk(Path) - Method in class com.dua3.gradle.jdkprovider.provision.JdkProvisioner: Removes an extracted JDK directory.
resolve(JdkQuery, boolean) - Method in class com.dua3.gradle.jdkprovider.resolver.JdkResolver: Resolves a JDK installation that matches the specified requirements.

S

setVersion(int) - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Set the JDK version.
setVersion(int) - Method in class com.dua3.gradle.jdkprovider.plugin.JdkSpecOverride: Sets the version of the JDK specification override.
setVersion(String) - Method in class com.dua3.gradle.jdkprovider.plugin.JdkExtension: Set the JDK version.
setVersion(String) - Method in class com.dua3.gradle.jdkprovider.plugin.JdkSpecOverride: Sets the version property for the JDK specification override.
sha256() - Method in record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Returns the value of the sha256 record component.
sha256Hex(Path) - Static method in class com.dua3.gradle.jdkprovider.provision.ChecksumUtil: Computes the SHA-256 checksum of the contents of the specified file and returns it as a hexadecimal string.
SOLARIS - Enum constant in enum class com.dua3.gradle.jdkprovider.types.OSFamily: Enumeration constant representing the Solaris operating system.
stableReleaseOnly() - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Returns the value of the stableReleaseOnly record component.
SystemArchitecture - Enum Class in com.dua3.gradle.jdkprovider.types: Represents the different types of system architectures and provides utility methods for working with architecture-related data.

T

toString() - Method in record class com.dua3.gradle.jdkprovider.local.JdkInstallation: Returns a string representation of this record class.
toString() - Method in record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Returns a string representation of this record class.
toString() - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Returns a string representation of this record class.
toString() - Method in record class com.dua3.gradle.jdkprovider.types.JdkSpec: Generates a string representation of the JdkSpec object detailing its characteristics, including version specification, operating system, architecture, vendor, native image capability, and whether JavaFX is bundled.
toString() - Method in enum class com.dua3.gradle.jdkprovider.types.OSFamily: Returns the name of this enum constant converted to lowercase.
toString() - Method in enum class com.dua3.gradle.jdkprovider.types.SystemArchitecture: Returns the lowercase string representation of the enumeration constant's name.
toString() - Method in class com.dua3.gradle.jdkprovider.types.VersionSpec

V

valueOf(String) - Static method in enum class com.dua3.gradle.jdkprovider.types.OSFamily: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.dua3.gradle.jdkprovider.types.SystemArchitecture: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.dua3.gradle.jdkprovider.types.OSFamily: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.dua3.gradle.jdkprovider.types.SystemArchitecture: Returns an array containing the constants of this enum class, in the order they are declared.
vendor() - Method in record class com.dua3.gradle.jdkprovider.types.JdkSpec: Returns the value of the vendor record component.
vendorSpec() - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Returns the value of the vendorSpec record component.
verifySha256(Path, String) - Static method in class com.dua3.gradle.jdkprovider.provision.ChecksumUtil: Verifies that the SHA-256 checksum of the specified file matches the expected checksum.
version() - Method in record class com.dua3.gradle.jdkprovider.types.DiscoPackage: Returns the value of the version record component.
version() - Method in record class com.dua3.gradle.jdkprovider.types.JdkSpec: Returns the value of the version record component.
versionSpec() - Method in record class com.dua3.gradle.jdkprovider.types.JdkQuery: Returns the value of the versionSpec record component.
VersionSpec - Class in com.dua3.gradle.jdkprovider.types: Represents a version specification with a range defined by minimum and maximum versions.

W

WINDOWS - Enum constant in enum class com.dua3.gradle.jdkprovider.types.OSFamily: Represents the Microsoft Windows family of operating systems.

X

X64 - Enum constant in enum class com.dua3.gradle.jdkprovider.types.SystemArchitecture: Represents the x86_64 (64-bit) system architecture with common aliases.
X86_32 - Enum constant in enum class com.dua3.gradle.jdkprovider.types.SystemArchitecture: Represents the 32-bit x86 system architecture.

A B C D E F G H I J L M N O P Q R S T V W X
All Classes and Interfaces|All Packages