Java Platform, Standard Edition & Java Development Kit 17

https://docs.oracle.com/en/java/javase/17/docs/api/
Admin
The Java Platform, Standard Edition (Java SE) APIs define the core Java platform for general-purpose...
Tokens:21,727,733
Snippets:239,683
Trust Score:9.7
Update:6 days ago
Show doc for...
Tokens:
Raw
### Configure, start, stop and dump a recording

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

Shows how to create a recording with the default configuration, start it, perform a garbage collection, wait, stop, and dump the recording to a temporary file. The example uses Configuration.getConfiguration("default"), new Recording(c), r.start(), System.gc(), Thread.sleep(5000), r.stop(), and r.dump(Files.createTempFile("my-recording", ".jfr")).

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

```

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

### getOffset()

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/text/DefaultStyledDocument.ElementSpec.html

Gets the starting offset.

```APIDOC
## getOffset()

### Description
Gets the starting offset.

### Method
getOffset

### Signature
`public int getOffset()`

### Returns
- **int** - The offset >= 0.
```

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

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

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

Gets the starting offset.

```APIDOC
## getOffset()

### Description
Gets the starting offset.

### Method
GET

### Signature
`public int getOffset()`

### Returns
- **int** - The starting offset.

```

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

### start()

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.management.rmi/javax/management/remote/rmi/RMIConnectorServer.html

Activates the connector server, that is starts listening for client connections.

```APIDOC
## Method: start()

### Description
Activates the connector server, that is starts listening for client connections.

### Usage Example
```java
server.start();
```
```

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

### Class literal example: Foo.class.getName()

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

Example using a class literal to get the Class object for a named class and print its name.

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

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

### void start()

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

Starts this recording.

```APIDOC
## Method: start()

### Description
Starts this recording.

### Signature
`public void start()`

### Parameters
None.

### Returns
void
```

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

### RecordingStream startAsync example

Source: https://docs.oracle.com/en/java/javase/17/docs/api/jdk.jfr/jdk/jfr/consumer/RecordingStream.html

Demonstrates how to start an asynchronous recording stream to monitor CPU usage for ten seconds using a try-with-resources block.

```java
 try (var stream = new RecordingStream()) {
   stream.enable("jdk.CPULoad").withPeriod(Duration.ofSeconds(1));
   stream.onEvent("jdk.CPULoad", event -> {
     System.out.println(event);
   });
   stream.startAsync();
   Thread.sleep(10_000);
 }
```

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

### getConfiguration() - javax.security.auth.login.Configuration (static)

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

Get the installed login Configuration.

```APIDOC
## getConfiguration()

### Description
Get the installed login Configuration.

### Method
GET

### Endpoint
javax.security.auth.login.Configuration#getConfiguration()

### Parameters
None

### Response
#### Success Response (200)
- **Configuration** - The installed login Configuration.
```

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

### Create a recording with a predefined configuration

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

Shows how to create a Recording using a predefined configuration obtained via Configuration.getConfiguration("default"). The recording is initially in the NEW state and must be started with start().

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

```

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

### filterReturnValue Example

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/invoke/MethodHandles.html

Java example showing how to use filterReturnValue to post-process the return value of a method handle. The example creates a method handle for String.concat and String.length, then applies filterReturnValue to get the length of the concatenated string.

```java
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
...
MethodHandle cat = lookup().findVirtual(String.class,
  "concat", methodType(String.class, String.class));
MethodHandle length = lookup().findVirtual(String.class,
  "length", methodType(int.class));
System.out.println((String) cat.invokeExact("x", "y")); // xy
MethodHandle f0 = filterReturnValue(cat, length);
System.out.println((int) f0.invokeExact("x", "y")); // 2
```

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

### init(KeyStore ks, char[] password)

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/KeyManagerFactory.html

Initializes this factory with a source of key material.

```APIDOC
## init(KeyStore ks, char[] password)

### Description
Initializes this factory with a source of key material.

### Method
`public final void init(KeyStore ks, char[] password) throws KeyStoreException, NoSuchAlgorithmException, UnrecoverableKeyException`

### Parameters
- **ks** (KeyStore) - Required - The key store or `null`.
- **password** (char[]) - Required - The password for recovering keys.

### Throws
- **KeyStoreException** - If this operation fails.
- **NoSuchAlgorithmException** - If the algorithm for recovering keys is not available.
- **UnrecoverableKeyException** - If the key cannot be recovered.
```

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

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

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/IntBuffer.html

Absolute bulk get method. Transfers ints from this buffer into the given destination array starting at the specified index.

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

### Description
Absolute bulk get method. Transfers ints from this buffer into the given destination array starting at the specified index. If there are fewer ints remaining in the buffer than are required to satisfy the request, no ints are transferred and a BufferUnderflowException is thrown.

### Method
IntBuffer get(int index, int[] dst)

### Parameters
- `index` (int) - Required - The index in this buffer from which the first int will be read; must be non-negative and less than limit()
- `dst` (int[]) - Required - The array into which ints are to be written

### Returns
- IntBuffer - This buffer

### Throws
- IndexOutOfBoundsException - If index is negative, not smaller than limit(), or if the preconditions on the offset and length parameters do not hold
- BufferUnderflowException - If there are not enough ints remaining in this buffer
```

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

### Start a process with modified working directory, environment, and output redirection

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

Shows how to configure a ProcessBuilder with a custom working directory, environment variables, and output redirection to a log file, then start the process. The example also demonstrates assertions on the redirect configuration and input stream.

```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;
 assert p.getInputStream().read() == -1;
 
```

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

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

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/DoubleBuffer.html

Absolute bulk get method. Copies doubles from this buffer into the given destination array starting at the given index.

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

### Description
Absolute bulk get method. Copies doubles from this buffer into the given destination array starting at the given index.

### Method
DoubleBuffer get(int index, double[] dst)

### Parameters
- `index` (int) - Required - The index in this buffer from which the first double will be read
- `dst` (double[]) - Required - The destination array

### Returns
This buffer
```

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

### get(short[], int, int) - java.nio.ShortBuffer

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

Relative bulk get method that transfers shorts from this buffer into the given destination array starting at the given offset.

```APIDOC
## get(short[], int, int) - Method in class java.nio.ShortBuffer

### Description
Relative bulk _get_ method. Transfers shorts from this buffer into the given destination array starting at the given offset.

### Method
GET

### Signature
`public ShortBuffer get(short[] dst, int offset, int length)`

### Parameters
- **dst** (short[]) - Required - The destination array
- **offset** (int) - Required - The offset within the array of the first short to be written
- **length** (int) - Required - The number of shorts to be transferred

### Returns
This buffer
```

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

### Create a recording stream with a predefined configuration

Source: https://docs.oracle.com/en/java/javase/17/docs/api/jdk.jfr/jdk/jfr/consumer/RecordingStream.html

This example shows how to initialize a RecordingStream using a predefined configuration and process all events.

```java
 var c = Configuration.getConfiguration("default");
 try (var rs = new RecordingStream(c)) {
   rs.onEvent(System.out::println);
   rs.start();
 }
 
```

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

### get(long[], int, int) - java.nio.LongBuffer

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

Relative bulk get method that transfers longs from this buffer into the given destination array starting at the given offset.

```APIDOC
## get(long[], int, int) - Method in class java.nio.LongBuffer

### Description
Relative bulk _get_ method. Transfers longs from this buffer into the given destination array starting at the given offset.

### Method
GET

### Signature
`public LongBuffer get(long[] dst, int offset, int length)`

### Parameters
- **dst** (long[]) - Required - The destination array
- **offset** (int) - Required - The offset within the array of the first long to be written
- **length** (int) - Required - The number of longs to be transferred

### Returns
This buffer
```

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

### start()

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.management/javax/management/remote/JMXConnectorServerMBean.html

Activates the connector server, making it start listening for client connections. Throws IOException if it cannot start or if the server has been stopped, and IllegalStateException if not attached to an MBean server.

```APIDOC
## start()

### Description
Activates the connector server, that is, starts listening for client connections. Calling this method when the connector server is already active has no effect. Calling this method when the connector server has been stopped will generate an IOException.

### Method
void start() throws IOException

### Parameters
None

### Throws
- **IOException** - if it is not possible to start listening or if the connector server has been stopped.
- **IllegalStateException** - if the connector server has not been attached to an MBean server.
```

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

### get(int, float[]) - Method in class java.nio.FloatBuffer

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

Absolute bulk get method that reads floats from this buffer into the given array starting at the given index.

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

### Description
Absolute bulk _get_ method.

### Method
get

### Signature
`public FloatBuffer get(int index, float[] dst)`

### Parameters
- **index** (int) - Required - The index from which the floats will be read.
- **dst** (float[]) - Required - The array to fill.

### Returns
This buffer.
```

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

### autoStart()

Source: https://docs.oracle.com/en/java/javase/17/docs/api/jdk.compiler/com/sun/source/util/Plugin.html

Returns whether or not this plugin should be automatically started, even if not explicitly specified in the command-line options.

```APIDOC
## autoStart()

### Description
Returns whether or not this plugin should be automatically started, even if not explicitly specified in the command-line options. This method will be called by javac for all plugins located by the service loader. If the method returns `true`, the plugin will be initialized with an empty array of string arguments if it is not otherwise initialized due to an explicit command-line option.

### Method
`default boolean autoStart()`

### Returns
- **boolean** - whether or not this plugin should be automatically started
```

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

### get(int, double[]) - Method in class java.nio.DoubleBuffer

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

Absolute bulk get method that reads doubles from this buffer into the given array starting at the given index.

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

### Description
Absolute bulk _get_ method.

### Method
get

### Signature
`public DoubleBuffer get(int index, double[] dst)`

### Parameters
- **index** (int) - Required - The index from which the doubles will be read.
- **dst** (double[]) - Required - The array to fill.

### Returns
This buffer.
```

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

### abstract void init(boolean forward)

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/security/cert/PKIXCertPathChecker.html

Initializes the internal state of this PKIXCertPathChecker.

```APIDOC
## Method: init(boolean forward)

### Description
Initializes the internal state of this PKIXCertPathChecker.

### Signature
abstract void init(boolean forward)

### Parameters
- **forward** (boolean) - Required - The order of the certificates to be checked. If true, certificates are presented in the forward direction (from target to most-trusted CA); if false, in the reverse direction (from most-trusted CA to target).

### Returns
void

### Throws
- CertPathValidatorException - if the initialization fails.
```

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

### init(Key key, AlgorithmParameterSpec params) : void

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/crypto/Mac.html

Initializes this Mac object with the given key and algorithm parameters.

```APIDOC
## init(Key key, AlgorithmParameterSpec params)

### Description
Initializes this `Mac` object with the given key and algorithm parameters.

### Method
final void init(Key key, AlgorithmParameterSpec params) throws InvalidKeyException, InvalidAlgorithmParameterException

### Parameters
- `key` (Key) - Required - The key.
- `params` (AlgorithmParameterSpec) - Required - The algorithm parameters.

### Throws
- `InvalidKeyException` - if the given key is inappropriate for initializing this MAC.
- `InvalidAlgorithmParameterException` - if the given algorithm parameters are inappropriate for this MAC.
```

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

### get(int, char[]) - Method in class java.nio.CharBuffer

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

Absolute bulk get method that reads chars from this buffer into the given array starting at the given index.

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

### Description
Absolute bulk _get_ method.

### Method
get

### Signature
`public CharBuffer get(int index, char[] dst)`

### Parameters
- **index** (int) - Required - The index from which the chars will be read.
- **dst** (char[]) - Required - The array to fill.

### Returns
This buffer.
```

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

### Example JAR URLs for entry, file, and directory

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/JarURLConnection.html

Three examples of JAR URLs: one for an entry, one for a JAR file, and one for a directory inside a JAR.

```text
jar:http://www.foo.com/bar/baz.jar!/COM/foo/Quux.class
```

```text
jar:http://www.foo.com/bar/baz.jar!/
```

```text
jar:http://www.foo.com/bar/baz.jar!/COM/foo/
```

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

### get(int, byte[]) - Method in class java.nio.ByteBuffer

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

Absolute bulk get method that reads bytes from this buffer into the given array starting at the given index.

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

### Description
Absolute bulk _get_ method.

### Method
get

### Signature
`public ByteBuffer get(int index, byte[] dst)`

### Parameters
- **index** (int) - Required - The index from which the bytes will be read.
- **dst** (byte[]) - Required - The array to fill.

### Returns
This buffer.
```

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

### getStartOffset() - Method in interface javax.swing.text.Highlighter.Highlight

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

Gets the starting model offset for the highlight.

```APIDOC
## getStartOffset()

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

### Method
`getStartOffset()`

### Interface
`javax.swing.text.Highlighter.Highlight`

### Returns
- `int` - The starting model offset.
```

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

### start()

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

Starts a new process using the attributes of this process builder. The new process will invoke the command and arguments given by command(), in a working directory as given by directory(), with a process environment as given by environment().

```APIDOC
## start()

### Description
Starts a new process using the attributes of this process builder. The new process will invoke the command and arguments given by command(), in a working directory as given by directory(), with a process environment as given by environment().

### Method
start

### Signature
public Process start() throws IOException

### Returns
- a new `Process` object for managing the subprocess

### Throws
- `NullPointerException` - if an element of the command list is null
- `IndexOutOfBoundsException` - if the command is an empty list (has size `0`)
- `SecurityException` - if a security manager exists and its `checkExec` method doesn't allow creation of the subprocess, or the standard input to the subprocess was redirected from a file and the security manager's `checkRead` method denies read access to the file, or the standard output or standard error of the subprocess was redirected to a file and the security manager's `checkWrite` method denies write access to the file
- `UnsupportedOperationException` - If the operating system does not support the creation of processes.
- `IOException` - if an I/O error occurs
```

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

### getStartOffset() - Method in class javax.swing.text.AbstractDocument.LeafElement

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

Gets the starting offset in the model for the element.

```APIDOC
## getStartOffset()

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

### Method
`getStartOffset()`

### Class
`javax.swing.text.AbstractDocument.LeafElement`

### Returns
- `int` - The starting offset.
```

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

### setupMenuOpenKey() - javax.swing.plaf.basic.BasicInternalFrameUI

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

Setup the menu open key.

```APIDOC
## setupMenuOpenKey() - Method in class javax.swing.plaf.basic.BasicInternalFrameUI

### Description
Setup the menu open key.

### Method
setupMenuOpenKey

### Parameters
None

### Returns
void
```

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

### getStartOffset() - Method in class javax.swing.text.AbstractDocument.BranchElement

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

Gets the starting offset in the model for the element.

```APIDOC
## getStartOffset()

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

### Method
`getStartOffset()`

### Class
`javax.swing.text.AbstractDocument.BranchElement`

### Returns
- `int` - The starting offset.
```

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

### start() - Method in MonitorMBean

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

Starts the monitor.

```APIDOC
## start() - Method in MonitorMBean

### Description
Starts the monitor.

### Method
`void start()`

### Usage
Call this method to start the monitor.
```

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

### start()

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

Starts this recording. After a successful invocation, the recording is in the RUNNING state.

```APIDOC
## start()

### Description
Starts this recording. It's recommended that the recording options and event settings are configured before calling this method. After a successful invocation, this recording is in the `RUNNING` state.

### Method
`public void start()`

### Throws
- `IllegalStateException` - if recording is already started or is in the `CLOSED` state
```

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

### getStartOffset() - Method in class javax.swing.text.AbstractDocument.AbstractElement

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

Gets the starting offset in the model for the element.

```APIDOC
## getStartOffset()

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

### Method
`getStartOffset()`

### Class
`javax.swing.text.AbstractDocument.AbstractElement`

### Returns
- `int` - The starting offset.
```

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

### JAR URL construction rules examples

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/JarURLConnection.html

Three examples showing how JAR URLs are constructed when using new URL(context, spec). Each example shows the context, spec, and resulting URL.

```text
context: jar:http://www.foo.com/bar/jar.jar!/ , spec: baz/entry.txt
url: jar:http://www.foo.com/bar/jar.jar!/baz/entry.txt
```

```text
context: jar:http://www.foo.com/bar/jar.jar!/baz , spec: entry.txt
url: jar:http://www.foo.com/bar/jar.jar!/baz/entry.txt
```

```text
context: jar:http://www.foo.com/bar/jar.jar!/baz , spec: /entry.txt
url: jar:http://www.foo.com/bar/jar.jar!/entry.txt
```

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

### getSelectionStart() - java.awt.TextComponent

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

Gets the start position of the selected text in this text component.

```APIDOC
## getSelectionStart()

### Description
Gets the start position of the selected text in this text component.

### Method
GET

### Endpoint
java.awt.TextComponent#getSelectionStart()

### Parameters
None

### Response
#### Success Response
- **return** (int) - The start position of the selected text.

```

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

### start()

Source: https://docs.oracle.com/en/java/javase/17/docs/api/jdk.jfr/jdk/jfr/consumer/EventStream.html

Starts processing of actions.

```APIDOC
## start()

### Description
Starts processing of actions.

### Method
void start()
```

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

### getRequestingScheme()

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/Authenticator.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
getRequestingScheme

### Returns
String - the scheme of the requestor
```

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

### LaunchingConnector.launch(Map<String,? extends Connector.Argument> arguments)

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

Launches an application and connects to its VM.

```APIDOC
## LaunchingConnector.launch(Map<String,? extends Connector.Argument> arguments)

### Description
Launches an application and connects to its VM.

### Method
launch

### Parameters
- **arguments** (Map<String,? extends Connector.Argument>) - The arguments for the connection.

### Returns
- **VirtualMachine** - A mirror of the target VM.
```

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

### get(int, short[], int, int) - java.nio.ShortBuffer

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

Absolute bulk get method that transfers shorts from this buffer into the given destination array starting at the given offset.

```APIDOC
## get(int, short[], int, int) - Method in class java.nio.ShortBuffer

### Description
Absolute bulk _get_ method. Transfers shorts from this buffer into the given destination array starting at the given offset.

### Method
GET

### Signature
`public ShortBuffer get(int index, short[] dst, int offset, int length)`

### Parameters
- **index** (int) - Required - The index from which the first short will be read
- **dst** (short[]) - Required - The destination array
- **offset** (int) - Required - The offset within the array of the first short to be written
- **length** (int) - Required - The number of shorts to be transferred

### Returns
This buffer
```

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

### get(int, long[], int, int) - java.nio.LongBuffer

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

Absolute bulk get method that transfers longs from this buffer into the given destination array starting at the given offset.

```APIDOC
## get(int, long[], int, int) - Method in class java.nio.LongBuffer

### Description
Absolute bulk _get_ method. Transfers longs from this buffer into the given destination array starting at the given offset.

### Method
GET

### Signature
`public LongBuffer get(int index, long[] dst, int offset, int length)`

### Parameters
- **index** (int) - Required - The index from which the first long will be read
- **dst** (long[]) - Required - The destination array
- **offset** (int) - Required - The offset within the array of the first long to be written
- **length** (int) - Required - The number of longs to be transferred

### Returns
This buffer
```

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

### Files.newByteChannel usage examples

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/file/Files.html

Examples showing how to open a file for reading, writing to the end of an existing file, and creating a file with initial permissions using Files.newByteChannel.

```java
Path path = ...

// open file for reading
ReadableByteChannel rbc = Files.newByteChannel(path, EnumSet.of(READ)));

// open file for writing to the end of an existing file, creating
// the file if it doesn't already exist
WritableByteChannel wbc = Files.newByteChannel(path, EnumSet.of(CREATE,APPEND));

// create file with initial permissions, opening it for both reading and writing
FileAttribute<Set<PosixFilePermission>> perms = ...
SeekableByteChannel sbc =
    Files.newByteChannel(path, EnumSet.of(CREATE_NEW,READ,WRITE), perms);
```

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

### GSSContext Usage Example (Initiating Peer)

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.security.jgss/org/ietf/jgss/GSSContext.html

Demonstrates the typical usage of the GSSContext interface for the initiating peer, including context creation, flag setting, context establishment, querying context information, performing wrap/unwrap operations, and disposing the context.

```APIDOC
## GSSContext Usage Example (Initiating Peer)

### Description
This example shows how to use the GSSContext interface for the initiating peer. It covers object instantiation, setting desired flags, context establishment, querying actual context flags, per-message operations on application data, and context deletion.

### Code Example
```java
// Create a context using default credentials
// and the implementation specific default mechanism
GSSManager manager = ...
GSSName targetName = ...
GSSContext context = manager.createContext(targetName, null, null,
                                       GSSContext.INDEFINITE_LIFETIME);

// set desired context options prior to context establishment
context.requestConf(true);
context.requestMutualAuth(true);
context.requestReplayDet(true);
context.requestSequenceDet(true);

// establish a context between peers

byte[] inToken = new byte[0];
byte[] outToken;

// Loop while there still is a token to be processed

while (!context.isEstablished()) {

    outToken = context.initSecContext(inToken, 0, inToken.length);

    // send the output token if generated
    if (outToken != null) {
        sendToken(outToken);
    }

    if (!context.isEstablished()) {
        inToken = readToken();
    }
}

 // display context information
 System.out.println("Remaining lifetime in seconds = "
                                      + context.getLifetime());
 System.out.println("Context mechanism = " + context.getMech());
 System.out.println("Initiator = " + context.getSrcName());
 System.out.println("Acceptor = " + context.getTargName());

 if (context.getConfState()) {
     System.out.println("Confidentiality (i.e., privacy) is available");
 }

 if (context.getIntegState()) {
     System.out.println("Integrity is available");
 }

 // perform wrap on an application supplied message, appMsg,
 // using QOP = 0, and requesting privacy service
 byte[] appMsg = ...

 MessageProp mProp = new MessageProp(0, true);

 outToken = context.wrap(appMsg, 0, appMsg.length, mProp);

 sendToken(outToken);

 // perform unwrap on an incoming application message, and check
 // its privacy state and supplementary information
 inToken = readToken();

 mProp = new MessageProp(0, true);

 appMsg = context.unwrap(inToken, 0, inToken.length, mProp);

 System.out.println("Was it encrypted? " + mProp.getPrivacy());
 System.out.println("Duplicate Token? " + mProp.isDuplicateToken());
 System.out.println("Old Token? " + mProp.isOldToken());
 System.out.println("Unsequenced Token? " + mProp.isUnseqToken());
 System.out.println("Gap Token? " + mProp.isGapToken());

 // the application determines if the privacy state and supplementary
 // information are acceptable

 // release the local-end of the context
 context.dispose();
```

### Since
1.4
```

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

### get(int, int[], int, int) - java.nio.IntBuffer

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

Absolute bulk get method that transfers ints from this buffer into the given destination array starting at the given offset.

```APIDOC
## get(int, int[], int, int) - Method in class java.nio.IntBuffer

### Description
Absolute bulk _get_ method. Transfers ints from this buffer into the given destination array starting at the given offset.

### Method
GET

### Signature
`public IntBuffer get(int index, int[] dst, int offset, int length)`

### Parameters
- **index** (int) - Required - The index from which the first int will be read
- **dst** (int[]) - Required - The destination array
- **offset** (int) - Required - The offset within the array of the first int to be written
- **length** (int) - Required - The number of ints to be transferred

### Returns
This buffer
```

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

### start() - Method in JMXConnectorServerMBean

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

Activates the connector server, that is, starts listening for client connections.

```APIDOC
## start() - Method in JMXConnectorServerMBean

### Description
Activates the connector server, that is, starts listening for client connections.

### Method
`void start()`

### Usage
Call this method to activate the connector server.
```

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

### get(byte[], int, int) - Method in class java.nio.ByteBuffer

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

Relative bulk get method. Reads bytes from the buffer into the given array starting at the given offset.

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

### Description
Relative bulk _get_ method. Reads bytes from the buffer into the given array starting at the given offset.

### Method
- **get(byte[], int, int)**

### Class
java.nio.ByteBuffer

### Parameters
- **dst** (byte[]) - Required - The array into which bytes are to be written.
- **offset** (int) - Required - The offset within the array of the first byte to be written.
- **length** (int) - Required - The number of bytes to be read.

### Returns
This buffer.
```

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

### KeyManagerFactorySpi.engineInit(KeyStore, char[])

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/security/class-use/KeyStore.html

Initializes this factory with a source of key material.

```APIDOC
## KeyManagerFactorySpi.engineInit(KeyStore, char[])

### Description
Initializes this factory with a source of key material.

### Method
protected abstract void engineInit(KeyStore ks, char[] password)

### Parameters
- **ks** (KeyStore) - Required - The keystore containing key material.
- **password** (char[]) - Required - The password for the keystore.
```

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

### get(int[] dst, int offset, int length)

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/IntBuffer.html

Relative bulk get method. Transfers ints from this buffer into the given destination array starting at the specified offset.

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

### Description
Relative bulk get method. Transfers ints from this buffer into the given destination array starting at the specified offset. If there are fewer ints remaining in the buffer than are required to satisfy the request, no ints are transferred and a BufferUnderflowException is thrown.

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

### Parameters
- `dst` (int[]) - Required - The array into which ints are to be written
- `offset` (int) - Required - The offset within the array of the first int to be written; must be non-negative and no larger than dst.length
- `length` (int) - Required - The maximum number of ints to be written; must be non-negative and no larger than dst.length - offset

### Returns
- IntBuffer - This buffer

### Throws
- BufferUnderflowException - If there are not enough ints remaining in this buffer
- IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold
```

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

### get(int, float[], int, int) - Method in class java.nio.FloatBuffer

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

Absolute bulk get method that reads floats into a subarray of the given array starting at the given index.

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

### Description
Absolute bulk _get_ method.

### Method
get

### Signature
`public FloatBuffer get(int index, float[] dst, int offset, int length)`

### Parameters
- **index** (int) - Required - The index from which the floats will be read.
- **dst** (float[]) - Required - The array to fill.
- **offset** (int) - Required - The offset within the array where the first float is written.
- **length** (int) - Required - The number of floats to read.

### Returns
This buffer.
```

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

### Record events with default configuration

Source: https://docs.oracle.com/en/java/javase/17/docs/api/jdk.jfr/jdk/jfr/consumer/RecordingStream.html

This example demonstrates how to record Garbage Collection, CPU Load, and JVM Information events using the default configuration and print them to standard output.

```java
 Configuration c = Configuration.getConfiguration("default");
 try (var rs = new RecordingStream(c)) {
     rs.onEvent("jdk.GarbageCollection", System.out::println);
     rs.onEvent("jdk.CPULoad", System.out::println);
     rs.onEvent("jdk.JVMInformation", System.out::println);
     rs.start();
 }
 
```

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

### get(int, double[], int, int) - Method in class java.nio.DoubleBuffer

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

Absolute bulk get method that reads doubles into a subarray of the given array starting at the given index.

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

### Description
Absolute bulk _get_ method.

### Method
get

### Signature
`public DoubleBuffer get(int index, double[] dst, int offset, int length)`

### Parameters
- **index** (int) - Required - The index from which the doubles will be read.
- **dst** (double[]) - Required - The array to fill.
- **offset** (int) - Required - The offset within the array where the first double is written.
- **length** (int) - Required - The number of doubles to read.

### Returns
This buffer.
```

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

### Example Configuration Entry

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

Example Configuration entry using the default syntax. Module options are specified as key-value pairs with the value in double quotes, and system properties in the form ${system.property} are expanded. This entry configures UnixLoginModule and Krb5LoginModule for the "Login" application.

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

```

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

### Naming convention example for a SyncProvider implementation

Source: https://docs.oracle.com/en/java/javase/17/docs/api/java.sql.rowset/javax/sql/rowset/spi/SyncProvider.html

Shows the recommended naming convention for a vendor-provided SyncProvider implementation, including vendor name, domain, package, and fully qualified class name.

```text
     Vendor name:  Fred, Inc.
     Domain name of vendor:  com.fred
     Package name:  com.fred.providers
     SyncProvider implementation class name:  HighAvailabilityProvider

     Fully qualified class name of SyncProvider implementation:
                        com.fred.providers.HighAvailabilityProvider
 
```
Tokens:
Raw