JDK 24

https://docs.oracle.com/en/java/javase/24/
Admin
JDK 24 is Oracle's Java Development Kit providing the latest Java Standard Edition platform with...
Tokens:18,604,659
Snippets:161,048
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example: Enabling and Configuring a Setting

Source: https://docs.oracle.com/en/java/javase/24/docs/api/jdk.jfr/jdk/jfr/SettingControl.html

This example demonstrates how to enable a custom setting and configure it with specific values when starting a recording.

```APIDOC
## Example: Configuring Recording Settings

```java
Recording r = new Recording();
r.enable("HTTPGetRequest").with("uriFilter", "https://www.example.com/list/.*");
r.enable("HTTPPostRequest").with("uriFilter", "https://www.example.com/login/.*");
r.start();
```
```

--------------------------------

### Create and Start a Simple Process

Source: https://docs.oracle.com/en/java/javase/24/core/creating-process.html

Use ProcessBuilder to specify the command and its arguments, then start the process. This example executes the 'echo' command.

```java
ProcessBuilder pb = new ProcessBuilder("echo", "Hello World!");
Process p = pb.start();
```

--------------------------------

### Starting a new process with default working directory and environment

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/ProcessBuilder.html

This example demonstrates how to start a new process using ProcessBuilder with default settings for the working directory and environment.

```APIDOC
## Starting a new process

### Description
Starts a new process with the specified command and arguments, using the default working directory and environment.

### Method
`start()`

### Endpoint
N/A (Java method call)

### Parameters
- `command` (String...) - The command and its arguments to execute.

### Request Example
```java
Process p = new ProcessBuilder("myCommand", "myArg").start();
```

### Response
- `Process` - An object representing the newly started process.
```

--------------------------------

### Start JConsole for Specific Local Application (Example)

Source: https://docs.oracle.com/en/java/javase/24/management/using-jconsole.html

Example of starting JConsole to monitor a local application with PID 2956.

```bash
% jconsole 2956
```

--------------------------------

### Example: Create Recording with Default Configuration

Source: https://docs.oracle.com/en/java/javase/24/docs/api/jdk.jfr/jdk/jfr/Recording.html

Demonstrates how to create a recording using the default configuration. The recording is created and ready to be started.

```java
Recording r = new Recording(Configuration.getConfiguration("default"));
```

--------------------------------

### Configure, Start, Stop, and Dump Recording

Source: https://docs.oracle.com/en/java/javase/24/docs/api/jdk.jfr/jdk/jfr/Recording.html

This example demonstrates how to configure a recording using a default configuration, start it, perform some operations, stop it, and then dump the collected data to a temporary file. Ensure to close the recording to release resources.

```java
Configuration c = Configuration.getConfiguration("default");
try (Recording r = new Recording(c)) {
    r.start();
    System.gc();
    Thread.sleep(5000);
    r.stop();
    r.dump(Files.createTempFile("my-recording", ".jfr"));
}

```

--------------------------------

### Method: installUI

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/plaf/synth/SynthTextPaneUI.html

Installs the UI for a component, performing several setup steps.

```APIDOC
## Method: installUI

### Description
Installs the UI for a component. This does the following things:
1. Sets opaqueness of the associated component according to its style, if the opaque property has not already been set by the client program.
2. Installs the default caret and highlighter into the associated component. These properties are only set if their current value is either `null` or an instance of `UIResource`.
3. Attaches to the editor and model. If there is no model, a default one is created.
4. Creates the view factory and the view hierarchy used to represent the model.

### Signature
public void installUI(JComponent c)

### Overrides
`installUI` in class `BasicEditorPaneUI`

### Parameters
* `c` (JComponent) - the editor component

### See Also
* `BasicTextUI.installUI(javax.swing.JComponent)`
* `ComponentUI.installUI(javax.swing.JComponent)`
```

--------------------------------

### Start Server Application with SSL Keystore

Source: https://docs.oracle.com/en/java/javase/24/management/monitoring-and-management-using-jmx-technology.html

Example command to start a Java application with SSL enabled, specifying the keystore and its password. This is part of setting up remote monitoring with JConsole and SSL.

```bash
% java -Djavax.net.ssl.keyStore=keystore \
  -Djavax.net.ssl.keyStorePassword=password Server
```

--------------------------------

### setup

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-19.html

Performs common constructor initialization and setup for file choosers.

```APIDOC
## setup(FileSystemView)

### Description
Performs common constructor initialization and setup.

### Method
`setup(FileSystemView)`

### Parameters
* **view** (FileSystemView) - The file system view to use for setup.
```

--------------------------------

### Example: Filtering rows starting with 'a'

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/RowFilter.html

This example demonstrates how to create a RowFilter that includes rows where at least one column's string value starts with the letter 'a'.

```APIDOC
```java
RowFilter<Object,Object> startsWithAFilter = new RowFilter<Object,Object>() {
  public boolean include(Entry<? extends Object, ? extends Object> entry) {
    for (int i = entry.getValueCount() - 1; i >= 0; i--) {
      if (entry.getStringValue(i).startsWith("a")) {
        // The value starts with "a", include it
        return true;
      }
    }
    // None of the columns start with "a"; return false so that this
    // entry is not shown
    return false;
  }
};
```
```

--------------------------------

### Get Recording Start Time

Source: https://docs.oracle.com/en/java/javase/24/docs/api/jdk.jfr/jdk/jfr/Recording.html

Retrieves the time when the recording was started. Returns null if the recording has not yet been started.

```java
public Instant getStartTime()
```

--------------------------------

### Instantiating KeyStore

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/security/KeyStore.html

Demonstrates different ways to obtain a KeyStore instance.

```APIDOC
## Instantiating KeyStore

### Description
Demonstrates different ways to obtain a KeyStore instance.

### Code Examples

*   **Specify an existing keystore file:**
    ```java
    // get keystore password
    char[] password = getPassword();

    // probe the keystore file and load the keystore entries
    KeyStore ks = KeyStore.getInstance(new File("keyStoreName"), password);
    ```
    The system will probe the specified file to determine its keystore type and return a keystore implementation with its entries already loaded. When this approach is used there is no need to call the keystore's `load` method.

*   **Rely on the default type:**
    ```java
    KeyStore ks = KeyStore.getInstance(KeyStore.getDefaultType());
    ```
    The system will return a keystore implementation for the default type.

*   **Provide a specific keystore type:**
    ```java
    KeyStore ks = KeyStore.getInstance("JKS");
    ```
    The system will return the most preferred implementation of the specified keystore type available in the environment.
```

--------------------------------

### HttpRequest Example

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.net.http/java/net/http/HttpRequest.html

Example of creating and sending a GET request using HttpClient and HttpRequest.

```APIDOC
```java
HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("http://foo.com/"))
      .build();

client.sendAsync(request, BodyHandlers.ofString())
      .thenApply(HttpResponse::body)
      .thenAccept(System.out::println)
      .join();
```
```

--------------------------------

### JFileChooser.setup(FileSystemView view)

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/filechooser/class-use/FileSystemView.html

Performs common constructor initialization and setup using a provided FileSystemView.

```APIDOC
## JFileChooser.setup(FileSystemView view)

### Description
Performs common constructor initialization and setup.

### Method
`protected void`

### Parameters
#### Path Parameters
- **view** (FileSystemView) - Required - The FileSystemView to use for setup.
```

--------------------------------

### Keytool Pre-configured Options File Example

Source: https://docs.oracle.com/en/java/javase/24/docs/specs/man/keytool.html

Demonstrates how a pre-configured options file (`preconfig`) can simplify keytool commands by setting default options.

```properties
    # A tiny pre-configured options file
    keytool.all = -keystore ${user.home}/ks
    keytool.list = -v
    keytool.genkeypair = -keyalg rsa
```

```bash
keytool -conf preconfig -list
```

```bash
keytool -keystore ~/ks -v -list
```

```bash
keytool -conf preconfig -genkeypair -alias me
```

```bash
keytool -keystore ~/ks -keyalg rsa -genkeypair -alias me
```

```bash
keytool -conf preconfig -genkeypair -alias you -keyalg ec
```

```bash
keytool -keystore ~/ks -keyalg rsa -genkeypair -alias you -keyalg ec
```

```bash
keytool -keystore ~/ks -genkeypair -alias you -keyalg ec
```

--------------------------------

### Match Start Index

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/util/regex/Matcher.html

Get the starting index of the previous match or a specific captured group.

```APIDOC
## start

### Description
Returns the start index of the previous match.

### Specified by
`start` in interface `MatchResult`

### Returns
- int: The index of the first character matched

### Throws
- `IllegalStateException`: If no match has yet been attempted, or if the previous match operation failed
```

```APIDOC
## start

### Description
Returns the start index of the subsequence captured by the given group during the previous match operation. Capturing groups are indexed from left to right, starting at one. Group zero denotes the entire pattern, so the expression _m._`start(0)` is equivalent to _m._`start()`.

### Specified by
`start` in interface `MatchResult`

### Parameters
- `group` (int) - The index of a capturing group in this matcher's pattern

### Returns
- int: The index of the first character captured by the group, or `-1` if the match was successful but the group itself did not match anything

### Throws
- `IllegalStateException`: If no match has yet been attempted, or if the previous match operation failed
- `IndexOutOfBoundsException`: If there is no capturing group in the pattern with the given index
```

```APIDOC
## start

### Description
Returns the start index of the subsequence captured by the given named-capturing group during the previous match operation.

### Specified by
`start` in interface `MatchResult`

### Parameters
- `name` (String) - The name of a named-capturing group in this matcher's pattern

### Returns
- int: The index of the first character captured by the group, or `-1` if the match was successful but the group itself did not match anything

### Throws
- `IllegalStateException`: If no match has yet been attempted, or if the previous match operation failed
- `IllegalArgumentException`: If there is no capturing group in the pattern with the given name

### Since
1.8
```

--------------------------------

### Creating and Starting Threads with Thread.Builder

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/Thread.html

Examples demonstrating the use of Thread.Builder to create and start platform and virtual threads, including daemon threads, named threads, and ThreadFactories. Ensure a Runnable task is defined before using these examples.

```java
Runnable runnable = ...

  // Start a daemon thread to run a task
  Thread thread = Thread.ofPlatform().daemon().start(runnable);
```

```java
Runnable runnable = ...

  // Create an unstarted thread with name "duke", its start() method
  // must be invoked to schedule it to execute.
  Thread thread = Thread.ofPlatform().name("duke").unstarted(runnable);
```

```java
Runnable runnable = ...

  // A ThreadFactory that creates daemon threads named "worker-0", "worker-1", ...
  ThreadFactory factory = Thread.ofPlatform().daemon().name("worker-", 0).factory();
```

```java
Runnable runnable = ...

  // Start a virtual thread to run a task
  Thread thread = Thread.ofVirtual().start(runnable);
```

```java
Runnable runnable = ...

  // A ThreadFactory that creates virtual threads
  ThreadFactory factory = Thread.ofVirtual().factory();
```

--------------------------------

### getConfiguration()

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Gets the identifier for the domain configuration data. Gets the installed login Configuration. Returns a predefined configuration.

```APIDOC
## getConfiguration()

### Description
Gets the identifier for the domain configuration data.

### Method
Method

### Class
java.security.DomainLoadStoreParameter
```

```APIDOC
## getConfiguration()

### Description
Get the installed login Configuration.

### Method
Static Method

### Class
javax.security.auth.login.Configuration
```

```APIDOC
## getConfiguration(String)

### Description
Returns a predefined configuration.

### Method
Static Method

### Class
jdk.jfr.Configuration
```

--------------------------------

### setupMenuOpenKey

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-19.html

Sets up the menu open key.

```APIDOC
## setupMenuOpenKey()

### Description
Setup the menu open key.

### Method
`setupMenuOpenKey()`
```

--------------------------------

### getOffset() - javax.swing.text.DefaultStyledDocument.ElementSpec

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Gets the starting offset.

```APIDOC
## getOffset()

### Description
Gets the starting offset.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
APIDOC

### Request Example
APIDOC

### Response
APIDOC

#### Success Response (200)
APIDOC

#### Response Example
APIDOC
```

--------------------------------

### Installation Methods

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/plaf/synth/SynthTableUI.html

Methods for installing defaults and listeners.

```APIDOC
## Method: installDefaults

### Description
Initializes JTable properties, such as font, foreground, and background. Properties are set if their current value is null or a UIResource, or if the current value is null for other properties.

### Signature
```java
protected void installDefaults()
```

### Overrides
`installDefaults` in class `BasicTableUI`

### See Also
* `ComponentUI.installUI(javax.swing.JComponent)`
```

```APIDOC
## Method: installListeners

### Description
Attaches listeners to the JTable.

### Signature
```java
protected void installListeners()
```

### Overrides
`installListeners` in class `BasicTableUI`
```

--------------------------------

### Start a Process with Default Settings

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/ProcessBuilder.html

This snippet shows how to start a new process using the default working directory and environment. Ensure the command and its arguments are correctly specified for your operating system.

```java
Process p = new ProcessBuilder("myCommand", "myArg").start();
```

--------------------------------

### getStartOffset() - Highlighter.Highlight

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Gets the starting model offset for the highlight.

```APIDOC
## getStartOffset() - Highlighter.Highlight

### Description
Gets the starting model offset for the highlight.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- `int` (int) - The starting model offset for the highlight.

### Response Example
None
```

--------------------------------

### BasicListUI.installUI

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/class-use/JComponent.html

Initializes the list UI by installing defaults, listeners, and keyboard actions.

```APIDOC
## installUI(JComponent c)

### Description
Initializes `this.list` by calling `installDefaults()`, `installListeners()`, and `installKeyboardActions()` in order.

### Returns
`void`
```

--------------------------------

### getStartOffset() - AbstractDocument.LeafElement

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Gets the starting offset in the model for the element.

```APIDOC
## getStartOffset() - AbstractDocument.LeafElement

### Description
Gets the starting offset in the model for the element.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- `int` (int) - The starting offset of the element in the model.

### Response Example
None
```

--------------------------------

### getStartOffset() - AbstractDocument.BranchElement

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Gets the starting offset in the model for the element.

```APIDOC
## getStartOffset() - AbstractDocument.BranchElement

### Description
Gets the starting offset in the model for the element.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- `int` (int) - The starting offset of the element in the model.

### Response Example
None
```

--------------------------------

### Initialization and Installation

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/plaf/basic/BasicTreeUI.html

Methods used to install and set up the necessary components, defaults, listeners, and keyboard actions for the BasicTreeUI.

```APIDOC
## installComponents

### Description
Installs the subcomponents of the tree, which is the renderer pane.

### Signature
`protected void installComponents()`

## installDefaults

### Description
Installs default properties.

### Signature
`protected void installDefaults()`

## installKeyboardActions

### Description
Registers keyboard actions.

### Signature
`protected void installKeyboardActions()`

## installListeners

### Description
Registers listeners.

### Signature
`protected void installListeners()`
```

--------------------------------

### getStartOffset() - AbstractDocument.AbstractElement

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Gets the starting offset in the model for the element.

```APIDOC
## getStartOffset() - AbstractDocument.AbstractElement

### Description
Gets the starting offset in the model for the element.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- `int` (int) - The starting offset of the element in the model.

### Response Example
None
```

--------------------------------

### Getting the Class Object Using a Class Literal

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/Class.html

This example shows how to get the `Class` object for a named class using a class literal.

```APIDOC
## Method
System.out.println("The name of class Foo is: " + Foo.class.getName());

### Description
Retrieves the `Class` object for the `Foo` class using a class literal and prints its name.
```

--------------------------------

### Install JDK using MSI Installer (Basic UI)

Source: https://docs.oracle.com/en/java/javase/24/install/installation-jdk-microsoft-windows-platforms.html

Run the MSI Enterprise Installer from the command line in basic UI mode. Ensure you have administrative permissions.

```shell
msiexec.exe /i jdk-24_windows-x64_bin.msi
```

--------------------------------

### Get Scanline Stride - Java

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/java/awt/image/ComponentSampleModel.html

Returns the scanline stride of the ComponentSampleModel. This is the number of data elements between the start of one scanline and the start of the next.

```java
public final int getScanlineStride()
```

--------------------------------

### Execute SampleServer

Source: https://docs.oracle.com/en/java/javase/24/security/use-java-gss-api-secure-message-exchanges-jaas-programming.html

Run the SampleServer application. This command sets Kerberos realm, KDC, credential handling, and the login configuration file, then starts the server listening on a specified port.

```bash
java -Djava.security.krb5.realm=<your_realm> \
 -Djava.security.krb5.kdc=<your_kdc> \
 -Djavax.security.auth.useSubjectCredsOnly=false\
 -Djava.security.auth.login.config=bcsLogin.conf \
 SampleServer <port_number>
```

--------------------------------

### Configuration Syntax Example

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/javax/security/auth/login/Configuration.html

This example demonstrates the default syntax for a Configuration entry, including application names, LoginModule classes, flags, and options.

```APIDOC
## Configuration Syntax

### Description
This section describes the syntax for defining authentication configurations, including application-specific entries and default settings.

### Syntax Example
```
      Name {
            ModuleClass  Flag    ModuleOptions;
            ModuleClass  Flag    ModuleOptions;
            ModuleClass  Flag    ModuleOptions;
      };
      Name {
            ModuleClass  Flag    ModuleOptions;
            ModuleClass  Flag    ModuleOptions;
      };
      other {
            ModuleClass  Flag    ModuleOptions;
            ModuleClass  Flag    ModuleOptions;
      };
```

### Flag Semantics
- **Required**: The LoginModule must succeed. Authentication continues regardless of success or failure.
- **Requisite**: The LoginModule must succeed. If it fails, authentication stops. If it succeeds, authentication continues.
- **Sufficient**: The LoginModule is not required to succeed. If it succeeds, authentication stops. If it fails, authentication continues.
- **Optional**: The LoginModule is not required to succeed. Authentication continues regardless of success or failure.

### Module Options
_ModuleOptions_ is a space-separated list of LoginModule-specific values passed to the LoginModules. Options are defined by the LoginModule itself. Example: `debug="true"`.

### Detailed Example
```
 Login {
   com.sun.security.auth.module.UnixLoginModule required;
   com.sun.security.auth.module.Krb5LoginModule optional
                   useTicketCache="true"
                   ticketCache="${user.home}${/}tickets";
 };
```
```

--------------------------------

### Get Thread Start Requests

Source: https://docs.oracle.com/en/java/javase/24/docs/api/jdk.jdi/com/sun/jdi/request/EventRequestManager.html

Retrieves an unmodifiable, live view of all enabled and disabled thread start requests. Changes to the requests are reflected in this list.

```java
List<ThreadStartRequest> threadStartRequests()
```

--------------------------------

### Example of name() method usage

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/module/ResolvedModule.html

This example demonstrates how to get the module name using the name() method, which is equivalent to invoking reference().descriptor().name().

```java
reference().descriptor().name()
```

--------------------------------

### Default Configuration Syntax Example

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/javax/security/auth/login/Configuration.html

Illustrates the default syntax for a Configuration object, showing how applications are mapped to lists of LoginModules with flags and options.

```plaintext
      Name {
            ModuleClass  Flag    ModuleOptions;
            ModuleClass  Flag    ModuleOptions;
            ModuleClass  Flag    ModuleOptions;
      };
      Name {
            ModuleClass  Flag    ModuleOptions;
            ModuleClass  Flag    ModuleOptions;
      };
      other {
            ModuleClass  Flag    ModuleOptions;
            ModuleClass  Flag    ModuleOptions;
      };
 
```

--------------------------------

### Configure and Start a Process with Redirected I/O

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/ProcessBuilder.html

This example demonstrates configuring a ProcessBuilder with a modified working directory, environment variables, and redirecting standard output and error to a log file. It also shows how to merge error streams and verify redirection settings.

```java
ProcessBuilder pb =
  new ProcessBuilder("myCommand", "myArg1", "myArg2");
Map<String, String> env = pb.environment();
env.put("VAR1", "myValue");
env.remove("OTHERVAR");
env.put("VAR2", env.get("VAR1") + "suffix");
pb.directory(new File("myDir"));
File log = new File("log");
pb.redirectErrorStream(true);
pb.redirectOutput(Redirect.appendTo(log));
Process p = pb.start();
assert pb.redirectInput() == Redirect.PIPE;
assert pb.redirectOutput().file() == log;
```

--------------------------------

### Get First Day of Week

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/time/temporal/WeekFields.html

Gets the first day-of-week for this WeekFields instance. This varies by culture, with examples like Sunday in the US and Monday for ISO 8601.

```java
DayOfWeek dow = weekFields.getFirstDayOfWeek();
```

--------------------------------

### get(short[], int, int)

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Performs a relative bulk get operation to retrieve a specified number of elements into a short array, starting at a given offset.

```APIDOC
## get(short[], int, int)

### Description
Performs a relative bulk get operation, retrieving a specified number of elements into a short array, starting at a given offset.

### Method
`get(short[] dst, int offset, int length)`

### Parameters
* **dst** (short[]) - The destination array to store the retrieved elements.
* **offset** (int) - The starting offset in the destination array.
* **length** (int) - The number of elements to retrieve.

### Classes/Interfaces
* `java.nio.ShortBuffer`
```

--------------------------------

### Example Java Command Line for Simple Unit

Source: https://docs.oracle.com/en/java/javase/24/docs/specs/simple-source-files-instance-main-methods-jls.html

Shows the command line used to start a Java Virtual Machine when the entry point is a simple compilation unit like `HelloWorld.java`.

```bash
java HelloWorld
```

--------------------------------

### installDefaults Method

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/plaf/synth/SynthSplitPaneUI.html

Installs the UI defaults for the SynthSplitPaneUI.

```APIDOC
## installDefaults Method

### Description
Installs the UI defaults.

### Method
`protected void installDefaults()`

### Overrides
`installDefaults` in class `BasicSplitPaneUI`
```

--------------------------------

### get(long[], int, int)

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Performs a relative bulk get operation to retrieve a specified number of elements into a long array, starting at a given offset.

```APIDOC
## get(long[], int, int)

### Description
Performs a relative bulk get operation, retrieving a specified number of elements into a long array, starting at a given offset.

### Method
`get(long[] dst, int offset, int length)`

### Parameters
* **dst** (long[]) - The destination array to store the retrieved elements.
* **offset** (int) - The starting offset in the destination array.
* **length** (int) - The number of elements to retrieve.

### Classes/Interfaces
* `java.nio.LongBuffer`
```

--------------------------------

### Example Provider Implementation

Source: https://docs.oracle.com/en/java/javase/24/security/pkcs11-reference-guide1.html

Illustrates a basic structure for implementing a custom PKCS#11 provider.

```java
return new MySecretKey(provider, algorithm, handle);
        }
    }
}
```

--------------------------------

### Get Pixel Stride - Java

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/java/awt/image/ComponentSampleModel.html

Returns the pixel stride of the ComponentSampleModel. This is the number of data elements between the start of one pixel and the start of the next pixel in the same scanline.

```java
public final int getPixelStride()
```

--------------------------------

### BasicTableUI Installation Methods

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/plaf/basic/BasicTableUI.html

Methods for installing UI defaults, keyboard actions, and listeners.

```APIDOC
## installDefaults()

### Description
Initialize JTable properties, e.g. font, foreground, and background.

### Method
`protected void installDefaults()`
```

```APIDOC
## installKeyboardActions()

### Description
Register all keyboard actions on the JTable.

### Method
`protected void installKeyboardActions()`
```

```APIDOC
## installListeners()

### Description
Attaches listeners to the JTable.

### Method
`protected void installListeners()`
```

--------------------------------

### getRequestingScheme()

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Gets the scheme of the requestor (the HTTP scheme for an HTTP firewall, for example).

```APIDOC
## getRequestingScheme()

### Description
Gets the scheme of the requestor (the HTTP scheme for an HTTP firewall, for example).

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

#### Success Response (N/A)
N/A
```

--------------------------------

### Example Java Command Line Invocation

Source: https://docs.oracle.com/en/java/javase/24/docs/specs/simple-source-files-instance-main-methods-jls.html

Demonstrates how to start a Java Virtual Machine by invoking the `main` method of a specified class with command-line arguments.

```bash
java Test reboot Bob Dot Enzo
```

--------------------------------

### Authenticator.getRequestingScheme()

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/class-use/String.html

Gets the scheme of the requestor (the HTTP scheme for an HTTP firewall, for example).

```APIDOC
## Authenticator.getRequestingScheme()

### Description
Gets the scheme of the requestor (the HTTP scheme for an HTTP firewall, for example).

### Method
```java
String
```
```

--------------------------------

### installPreviewPanel()

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-9.html

Installs the preview panel.

```APIDOC
## installPreviewPanel()

### Description
Installs preview panel.

### Method
Method

### Class
javax.swing.plaf.basic.BasicColorChooserUI
```

--------------------------------

### BasicMenuItemUI Installation Methods

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/plaf/basic/BasicMenuItemUI.html

Methods for installing UI components, defaults, keyboard actions, and listeners.

```APIDOC
## installComponents(JMenuItem menuItem)

### Description
Registers the subcomponents of the menu.

### Method
`protected void installComponents(JMenuItem menuItem)`
```

```APIDOC
## installDefaults()

### Description
Installs default properties.

### Method
`protected void installDefaults()`
```

```APIDOC
## installKeyboardActions()

### Description
Registers keyboard action.

### Method
`protected void installKeyboardActions()`
```

```APIDOC
## installListeners()

### Description
Registers listeners.

### Method
`protected void installListeners()`
```

--------------------------------

### Start JShell

Source: https://docs.oracle.com/en/java/javase/24/jshell/introduction-jshell.html

Enter the 'jshell' command to start the Java Shell tool. Ensure JDK 9 or higher is installed and its bin directory is in your system's PATH.

```bash
% jshell
|  Welcome to JShell -- Version 17.0.1
|  For an introduction type: /help intro

jshell> 
```

--------------------------------

### setupMenuCloseKey

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-19.html

Sets up the menu close key.

```APIDOC
## setupMenuCloseKey()

### Description
Setup the menu close key.

### Method
`setupMenuCloseKey()`
```

--------------------------------

### jlink Options File Example

Source: https://docs.oracle.com/en/java/javase/24/docs/specs/man/jlink.html

This example shows how to use an options file to configure the jlink command. Options can be specified on multiple lines, and lines starting with '#' are comments.

```bash
#Wed Dec 07 00:40:19 EST 2016
--module-path mlib
--add-modules com.greetings
--output greetingsapp
```

--------------------------------

### BasicToolTipUI.installDefaults

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/class-use/JComponent.html

Installs default properties for the tooltip UI.

```APIDOC
## installDefaults(JComponent c)

### Description
Installs default properties.

### Returns
`protected void`
```

--------------------------------

### Basic RowFilter Example: Starts With 'a'

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/RowFilter.html

Implement a RowFilter to include entries where at least one column's string value starts with 'a'. This is useful for simple text-based filtering.

```java
RowFilter<Object,Object> startsWithAFilter = new RowFilter<Object,Object>() {
  public boolean include(Entry<? extends Object, ? extends Object> entry) {
    for (int i = entry.getValueCount() - 1; i >= 0; i--) {
      if (entry.getStringValue(i).startsWith("a")) {
        // The value starts with "a", include it
        return true;
      }
    }
    // None of the columns start with "a"; return false so that this
    // entry is not shown
    return false;
  }
 };
```

--------------------------------

### Getting Text Start Position with XMLStreamReader

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.xml/javax/xml/stream/XMLStreamReader.html

Retrieves the starting offset of the text within the character array for the current text event. This method is only valid for text-related events.

```java
int getTextStart()

```

--------------------------------

### installUI Method

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/plaf/ComponentUI.html

Configures a component for the look and feel by installing default properties, layout managers, event listeners, and keyboard UI.

```APIDOC
## installUI

### Description
Configures the specified component appropriately for the look and feel. This method is invoked when the `ComponentUI` instance is being installed as the UI delegate on the specified component. It should completely configure the component, including installing default properties, layout managers, sub-components, event listeners, property change listeners, and keyboard UI.

### Signature
public void installUI(JComponent c)

### Parameters
* `c` (JComponent) - The component where this UI delegate is being installed.

### See Also
* `uninstallUI(javax.swing.JComponent)`
* `JComponent.setUI(javax.swing.plaf.ComponentUI)`
* `JComponent.updateUI()`
```

--------------------------------

### Get Matcher Region Start Index (Java)

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/util/regex/Matcher.html

Reports the starting index of the region where the matcher will conduct its searches. Matches are found within the range [regionStart(), regionEnd()).

```java
public int regionStart()
```

--------------------------------

### install Method

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/text/EditorKit.html

Called when the kit is being installed into the a JEditorPane.

```APIDOC
## install(JEditorPane c)

### Description
Called when the kit is being installed into the a JEditorPane.

### Method
public void install(JEditorPane c)

### Parameters
#### Path Parameters
- **c** (JEditorPane) - the JEditorPane
```

--------------------------------

### getTableCellEditorComponent

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/DefaultCellEditor.html

Sets an initial `value` for the editor. This is called each time the editor is invoked. For example, when editing is invoked on a cell, this method is invoked to get the cell editor component. The component is then installed in the cell being edited. The `table` and `isSelected` arguments are needed to set up the editor appropriately. If the `value` is `null`, the editor is not installed. If the editor is not installed, the `getCellEditorValue` method is not called.

Parameters:
* `table` - the `JTable` that is asking the editor to edit; can be `null`
* `value` - the value of the cell to be edited; it is up to the specific editor to interpret and draw the value. For example, if value is the string "true", it could be rendered as a string or it could be rendered as a check box that is checked. `null` is a valid value
* `isSelected` - true if the cell is to be rendered with highlighting
* `row` - the row of the cell being edited
* `column` - the column of the cell being edited

Returns:
the component for editing

```APIDOC
## getTableCellEditorComponent

### Description
Sets an initial `value` for the editor. This is called each time the editor is invoked. For example, when editing is invoked on a cell, this method is invoked to get the cell editor component. The component is then installed in the cell being edited. The `table` and `isSelected` arguments are needed to set up the editor appropriately. If the `value` is `null`, the editor is not installed. If the editor is not installed, the `getCellEditorValue` method is not called.

### Method
`Component getTableCellEditorComponent(JTable table, Object value, boolean isSelected, int row, int column)`

### Parameters
#### Path Parameters
- **table** (JTable) - the `JTable` that is asking the editor to edit; can be `null`
- **value** (Object) - the value of the cell to be edited; it is up to the specific editor to interpret and draw the value. For example, if value is the string "true", it could be rendered as a string or it could be rendered as a check box that is checked. `null` is a valid value
- **isSelected** (boolean) - true if the cell is to be rendered with highlighting
- **row** (int) - the row of the cell being edited
- **column** (int) - the column of the cell being edited

### Returns
the component for editing
```

--------------------------------

### prepareForUIInstall()

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-16.html

Invoked after the tree instance variable has been set, but before any defaults/listeners have been installed.

```APIDOC
## prepareForUIInstall()

### Description
Invoked after the `tree` instance variable has been set, but before any defaults/listeners have been installed.

### Method
N/A (Method)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Start JConsole with SSL Truststore

Source: https://docs.oracle.com/en/java/javase/24/management/monitoring-and-management-using-jmx-technology.html

Example command to start JConsole with SSL enabled, specifying the truststore and its password. This allows JConsole to connect to a remote application secured with SSL.

```bash
% jconsole -J-Djavax.net.ssl.trustStore=truststore \
  -J-Djavax.net.ssl.trustStorePassword=trustword
```

--------------------------------

### Example Domain Configuration

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/security/DomainLoadStoreParameter.html

An example demonstrating a keystore domain named 'app1' with three distinct keystores, each configured with specific URIs and types.

```plaintext
domain app1 {
    keystore app1-truststore
        keystoreURI="file:///app1/etc/truststore.jks";

    keystore system-truststore
        keystoreURI="${java.home}/lib/security/cacerts";

    keystore app1-keystore
        keystoreType="PKCS12"
        keystoreURI="file:///app1/etc/keystore.p12";
 };
```

--------------------------------

### Get Java File for Input Example

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.compiler/javax/tools/JavaFileManager.html

Demonstrates how to get a file object for input representing a resource within a package. The returned object might be null if the file does not exist.

```java
getFileForInput(SOURCE_PATH, "com.sun.tools.javac", "resources/compiler.properties");

```

--------------------------------

### Instantiate LoginContext (Tutorial Specific)

Source: https://docs.oracle.com/en/java/javase/24/security/jaas-authentication-tutorial.html

Shows the specific instantiation of a LoginContext used in the tutorial, with 'Sample' as the configuration entry and a custom MyCallbackHandler.

```java
import javax.security.auth.login.*;
// ...
LoginContext lc =
    new LoginContext("Sample",
          new MyCallbackHandler());

```

--------------------------------

### installDefaults Method

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/plaf/basic/BasicDesktopPaneUI.html

Installs default properties for the BasicDesktopPaneUI.

```APIDOC
## installDefaults()

### Description
Installs default properties.

### Method
`protected void installDefaults()`
```

--------------------------------

### get(int, short[], int, int)

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Performs an absolute bulk get operation to retrieve a specified number of shorts from a buffer into a short array, starting at a given offset.

```APIDOC
## get(int, short[], int, int)

### Description
Performs an absolute bulk get operation, retrieving a specified number of shorts from a buffer into a short array, starting at a given offset.

### Method
`get(int index, short[] dst, int offset, int length)`

### Parameters
* **index** (int) - The starting index in the buffer.
* **dst** (short[]) - The destination array to store the retrieved shorts.
* **offset** (int) - The starting offset in the destination array.
* **length** (int) - The number of shorts to retrieve.

### Classes/Interfaces
* `java.nio.ShortBuffer`
```

--------------------------------

### get(int, long[], int, int)

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Performs an absolute bulk get operation to retrieve a specified number of longs from a buffer into a long array, starting at a given offset.

```APIDOC
## get(int, long[], int, int)

### Description
Performs an absolute bulk get operation, retrieving a specified number of longs from a buffer into a long array, starting at a given offset.

### Method
`get(int index, long[] dst, int offset, int length)`

### Parameters
* **index** (int) - The starting index in the buffer.
* **dst** (long[]) - The destination array to store the retrieved longs.
* **offset** (int) - The starting offset in the destination array.
* **length** (int) - The number of longs to retrieve.

### Classes/Interfaces
* `java.nio.LongBuffer`
```

--------------------------------

### Create SampleClient JAR

Source: https://docs.oracle.com/en/java/javase/24/security/use-jaas-login-utility-and-java-gss-api-secure-message-exchanges.html

Create a JAR file named SampleClient.jar containing SampleClient.class. This JAR contains the main client logic.

```bash
jar -cvf SampleClient.jar SampleClient.class
```

--------------------------------

### get(int, int[], int, int)

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Performs an absolute bulk get operation to retrieve a specified number of integers from a buffer into an int array, starting at a given offset.

```APIDOC
## get(int, int[], int, int)

### Description
Performs an absolute bulk get operation, retrieving a specified number of integers from a buffer into an int array, starting at a given offset.

### Method
`get(int index, int[] dst, int offset, int length)`

### Parameters
* **index** (int) - The starting index in the buffer.
* **dst** (int[]) - The destination array to store the retrieved integers.
* **offset** (int) - The starting offset in the destination array.
* **length** (int) - The number of integers to retrieve.

### Classes/Interfaces
* `java.nio.IntBuffer`
```

--------------------------------

### get(int, float[], int, int)

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Performs an absolute bulk get operation to retrieve a specified number of floats from a buffer into a float array, starting at a given offset.

```APIDOC
## get(int, float[], int, int)

### Description
Performs an absolute bulk get operation, retrieving a specified number of floats from a buffer into a float array, starting at a given offset.

### Method
`get(int index, float[] dst, int offset, int length)`

### Parameters
* **index** (int) - The starting index in the buffer.
* **dst** (float[]) - The destination array to store the retrieved floats.
* **offset** (int) - The starting offset in the destination array.
* **length** (int) - The number of floats to retrieve.

### Classes/Interfaces
* `java.nio.FloatBuffer`
```

--------------------------------

### Java Instance Creation and Initialization Example

Source: https://docs.oracle.com/en/java/javase/24/docs/specs/flexible-constructor-bodies-jls.html

Demonstrates the step-by-step process of creating a new class instance, including implicit constructor calls and initialization of fields. This example illustrates how constructors are invoked and fields are assigned values according to Java's rules.

```java
class Point {
    int x, y;
    Point() { x = 1; y = 1; }
}
class ColoredPoint extends Point {
    int color = 0xFF00FF;
}
class Test {
    public static void main(String[] args) {
        ColoredPoint cp = new ColoredPoint();
        System.out.println(cp.color);
    }
}
```

```java
ColoredPoint() { super(); }
```

```java
Point() { super(); x = 1; y = 1; }
```

```java
Object() { }
```

--------------------------------

### get(int, double[], int, int)

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Performs an absolute bulk get operation to retrieve a specified number of doubles from a buffer into a double array, starting at a given offset.

```APIDOC
## get(int, double[], int, int)

### Description
Performs an absolute bulk get operation, retrieving a specified number of doubles from a buffer into a double array, starting at a given offset.

### Method
`get(int index, double[] dst, int offset, int length)`

### Parameters
* **index** (int) - The starting index in the buffer.
* **dst** (double[]) - The destination array to store the retrieved doubles.
* **offset** (int) - The starting offset in the destination array.
* **length** (int) - The number of doubles to retrieve.

### Classes/Interfaces
* `java.nio.DoubleBuffer`
```

--------------------------------

### installUI

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/plaf/basic/BasicListUI.html

Initializes the JList by calling installDefaults(), installListeners(), and installKeyboardActions() in order.

```APIDOC
## installUI(JComponent c)

### Description
Initializes the JList by calling installDefaults(), installListeners(), and installKeyboardActions() in order.

### Method
void
```

--------------------------------

### installUI Method

Source: https://docs.oracle.com/en/java/javase/24/docs/api/java.desktop/javax/swing/plaf/basic/BasicSpinnerUI.html

Calls installDefaults, installListeners, and then adds the components returned by createNextButton, createPreviousButton, and createEditor.

```APIDOC
## installUI

public void installUI(JComponent c)

Calls `installDefaults`, `installListeners`, and then adds the components returned by `createNextButton`, `createPreviousButton`, and `createEditor`. 

Overrides:
    `installUI` in class `ComponentUI` 

Parameters:
    `c` - the JSpinner 

See Also:
    
      * `installDefaults()`
      * `installListeners()`
      * `createNextButton()`
      * `createPreviousButton()`
      * `createEditor()`
```

--------------------------------

### get(int, char[], int, int)

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Performs an absolute bulk get operation to retrieve a specified number of characters from a buffer into a char array, starting at a given offset.

```APIDOC
## get(int, char[], int, int)

### Description
Performs an absolute bulk get operation, retrieving a specified number of characters from a buffer into a char array, starting at a given offset.

### Method
`get(int index, char[] dst, int offset, int length)`

### Parameters
* **index** (int) - The starting index in the buffer.
* **dst** (char[]) - The destination array to store the retrieved characters.
* **offset** (int) - The starting offset in the destination array.
* **length** (int) - The number of characters to retrieve.

### Classes/Interfaces
* `java.nio.CharBuffer`
```

--------------------------------

### Running the JAAS Authentication Tutorial

Source: https://docs.oracle.com/en/java/javase/24/security/jaas-authentication-tutorial.html

Command to run the JAAS authentication tutorial with preview enabled and specifying the login configuration file.

```bash
$ java --enable-preview -Djava.security.auth.login.config==sample_jaas.config sample.SampleAcn

```

--------------------------------

### get(int, byte[], int, int)

Source: https://docs.oracle.com/en/java/javase/24/docs/api/index-files/index-7.html

Performs an absolute bulk get operation to retrieve a specified number of bytes from a buffer into a byte array, starting at a given offset.

```APIDOC
## get(int, byte[], int, int)

### Description
Performs an absolute bulk get operation, retrieving a specified number of bytes from a buffer into a byte array, starting at a given offset.

### Method
`get(int index, byte[] dst, int offset, int length)`

### Parameters
* **index** (int) - The starting index in the buffer.
* **dst** (byte[]) - The destination array to store the retrieved bytes.
* **offset** (int) - The starting offset in the destination array.
* **length** (int) - The number of bytes to retrieve.

### Classes/Interfaces
* `java.nio.ByteBuffer`
```

--------------------------------

### Instantiate LoginContext (Tutorial Specific)

Source: https://docs.oracle.com/en/java/javase/24/security/jaas-authentication.html

Demonstrates instantiating a LoginContext with specific values for the tutorial, using 'JaasSample' as the configuration entry and TextCallbackHandler for user interaction.

```java
import javax.security.auth.login.*;
import com.sun.security.auth.callback.TextCallbackHandler;
. . .
LoginContext lc =
    new LoginContext("JaasSample",
          new TextCallbackHandler());

```
Tokens:
Raw