Java SE 8 API

https://docs.oracle.com/javase/8/docs/api/
Admin
Java SE 8 API is the comprehensive application programming interface for Java Platform Standard...
Tokens:11,294,047
Snippets:117,351
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example: Create Memory File System

Source: https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystems.html

Demonstrates creating a new file system using a hypothetical 'memory' provider with specific environment properties for capacity and block size.

```java
Map<String,String> env = new HashMap<>();
   env.put("capacity", "16G");
   env.put("blockSize", "4k");
   FileSystem fs = FileSystems.newFileSystem(URI.create("memory:///?name=logfs"), env);

```

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

### Get Start Offset

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/text/AbstractDocument.BranchElement.html

Gets the starting offset in the model for the element.

```java
public int getStartOffset()
```

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

### Resource Bundle Files Example

Source: https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html

Lists the available resource bundle files for demonstration. These include class and properties files for different locales.

```text
MyResources.class
MyResources.properties
MyResources_fr.properties
MyResources_fr_CH.class
MyResources_fr_CH.properties
MyResources_en.properties
MyResources_es_ES.class

```

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

### Get Entry Position from Index

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/SizeSequence.html

Returns the starting position for a specified entry index. For example, getPosition(1) equals getSize(0). Behavior is undefined if index is out of bounds.

```Java
public int getPosition(int index)

```

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

### setupMenuOpenKey

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicInternalFrameUI.html

Sets up the key binding for opening the menu.

```APIDOC
## setupMenuOpenKey

### Description
Sets up the key binding for opening the menu.

### Method
`protected void`

### Signature
`setupMenuOpenKey()`
```

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

### Get Start Index of Link

Source: https://docs.oracle.com/javase/8/docs/api/javax/accessibility/AccessibleHyperlink.html

Gets the starting index of the hypertext link within its document.

```Java
public abstract int getStartIndex()
```

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

### Get Start Offset

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/text/AbstractDocument.AbstractElement.html

Gets the starting offset of the element within the model. Implements the getStartOffset method from the Element interface.

```Java
public abstract
int
getStartOffset()
```

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

### prepareForUIInstall

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicTreeUI.html

Prepares the UI delegate for installation. This method is called after the tree instance has been set but before defaults and listeners are installed.

```APIDOC
## prepareForUIInstall()

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

### Method
protected void
```

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

### installPreviewPanel()

Source: https://docs.oracle.com/javase/8/docs/api/index-files/index-9.html

Installs the preview panel. Part of BasicColorChooserUI.

```APIDOC
## installPreviewPanel()

### Description
Installs the preview panel.

### Method
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
```

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

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

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/RowFilter.html

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

```APIDOC
## Example: RowFilter for entries starting with 'a'

```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;
  }
};
```
```

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

### Selection Start

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/text/JTextComponent.html

Gets the start position of the current text selection.

```APIDOC
## getSelectionStart()

### Description
Returns the selected text's start position.

### Method
GET

### Endpoint
/JTextComponent/getSelectionStart
```

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

### Default Configuration Syntax Example

Source: https://docs.oracle.com/javase/8/docs/api/javax/security/auth/login/Configuration.html

Illustrates the default syntax for a Configuration entry, showing application names, LoginModule classes, 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;
      };
 
```

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

### Get Start Time

Source: https://docs.oracle.com/javase/8/docs/api/javax/security/auth/kerberos/KerberosTicket.html

Retrieves the start time for this ticket's validity period.

```Java
public final Date getStartTime()

```

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

### Example Property File Lines

Source: https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html

Illustrates different ways to specify a key-element pair in a properties file, including using '=' or ':' as separators and handling whitespace.

```properties
 Truth = Beauty
  Truth:Beauty
 Truth                    :Beauty
```

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

### Get Start Point

Source: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/QuadCurve2D.Double.html

Returns the start point of the quadratic curve as a Point2D object.

```java
public Point2D getP1()
```

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

### NimbusStyle.installDefaults(SynthContext)

Source: https://docs.oracle.com/javase/8/docs/api/index-files/index-9.html

Installs the necessary state from this Style on the JComponent from context.

```APIDOC
## installDefaults(SynthContext)

### Description
Installs the necessary state from this Style on the `JComponent` from `context`.

### Method
`installDefaults`

### Parameters
- **SynthContext** (SynthContext) - The context containing the JComponent and Style information.
```

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

### installDefaults Method

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicColorChooserUI.html

Installs default settings for the UI delegate.

```Java
protected
void
installDefaults()
```

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

### Get selection start position

Source: https://docs.oracle.com/javase/8/docs/api/serialized-form.html

Retrieves the starting index of the selected text within the component.

```Java
int selectionStart
```

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

### Get LocalDateTime at Start of Day

Source: https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html

Obtains a LocalDateTime representing the start of the date (midnight, 00:00).

```java
public LocalDateTime atStartOfDay()
```

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

### installComponents Method

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicDesktopIconUI.html

Installs the components for the desktop icon.

```APIDOC
## installComponents()

### Description
Installs the components for the desktop icon.

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

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

### GridBagLayout Main Method Example

Source: https://docs.oracle.com/javase/8/docs/api/java/awt/GridBagLayout.html

Sets up a Frame and adds a GridBagLayout component to it. Demonstrates packing and showing the frame.

```java
public static void main(String args[]) {
         Frame f = new Frame("GridBag Layout Example");
         GridBagEx1 ex1 = new GridBagEx1();

         ex1.init();

         f.add("Center", ex1);
         f.pack();
         f.setSize(f.getPreferredSize());
         f.show();
     }
```

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

### getBeginIndex() - Get start index

Source: https://docs.oracle.com/javase/8/docs/api/java/text/CharacterIterator.html

Returns the starting index of the text range managed by the iterator.

```java
int getBeginIndex()

```

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

### Get Run Start Index

Source: https://docs.oracle.com/javase/8/docs/api/java/text/Bidi.html

Returns the character index at the start of the nth logical run.

```java
public int getRunStart(int run)
```

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

### Setting Initial File Permissions

Source: https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/PosixFileAttributeView.html

Demonstrates how to set initial POSIX file permissions when creating a file using `Files.createFile` and `PosixFilePermissions.asFileAttribute`.

```java
Path path = ...
Set<PosixFilePermission> perms =
    EnumSet.of(OWNER_READ, OWNER_WRITE, OWNER_EXECUTE, GROUP_READ);
Files.createFile(path, PosixFilePermissions.asFileAttribute(perms));

```

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

### installDefaults(SynthContext context)

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/synth/SynthStyle.html

Installs the necessary state from this Style on the JComponent from context. This method is called during the component's initialization.

```APIDOC
## installDefaults(SynthContext context)

### Description
Installs the necessary state from this Style on the `JComponent` from `context`.

### Method
```java
public void installDefaults(SynthContext context)
```

### Parameters
#### Path Parameters
- **context** (SynthContext) - Description not available
```

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

### Get Y1 Coordinate of Start Point

Source: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/QuadCurve2D.Double.html

Retrieves the Y coordinate of the start point of the quadratic curve.

```java
public double getY1()
```

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

### Example Keystore Domain Configuration

Source: https://docs.oracle.com/javase/8/docs/api/java/security/DomainLoadStoreParameter.html

A practical example demonstrating the configuration of a keystore domain named 'app1' with three distinct keystores.

```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";
 };
 
```

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

### CubicCurve2D.Float - Get Start Point

Source: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/CubicCurve2D.Float.html

Returns the start point of the cubic curve as a Point2D object.

```java
public Point2D getP1() 
```

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

### start

Source: https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html

Returns the start index of the previous match. Overloaded versions allow specifying a group to get the start index for that specific capturing group.

```APIDOC
## start

### Description
Returns the start index of the previous match. Overloaded versions allow specifying a group to get the start index for that specific capturing group.

### Method
start

### Parameters
* **group** (int) - Optional. The group number for which to return the start index.
* **name** (String) - Optional. The name of the named-capturing group for which to return the start index.

### Returns
(int) - The start index of the matched subsequence.
```

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

### install Method

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/text/StyledEditorKit.html

Called when the kit is being installed into a JEditorPane.

```java
public	void	install(JEditorPane	c)

```

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

### Get Sequencer Loop Start Point

Source: https://docs.oracle.com/javase/8/docs/api/javax/sound/midi/Sequencer.html

Retrieves the current loop start position in MIDI ticks.

```java
long getLoopStartPoint()
```

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

### installDefaults

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicDesktopPaneUI.html

Installs the default properties for the BasicDesktopPaneUI.

```APIDOC
## installDefaults()

### Description
Installs the default properties for the BasicDesktopPaneUI.

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

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

### install

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/text/StyledEditorKit.html

Called when the kit is being installed into a JEditorPane.

```APIDOC
## install(JEditorPane c)

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

### Overrides
`install` in class `EditorKit`

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

### Method Signature
`public void install(JEditorPane c)`
```

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

### Get X1 Coordinate of Start Point

Source: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/QuadCurve2D.Double.html

Retrieves the X coordinate of the start point of the quadratic curve.

```java
public double getX1()
```

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

### Get Selection Start Index

Source: https://docs.oracle.com/javase/8/docs/api/javax/accessibility/AccessibleText.html

Returns the starting offset of the currently selected text. If no text is selected but a caret is present, the start and end offsets will be identical.

```Java
int
getSelectionStart()
```

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

### Basic GroupLayout Setup

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/GroupLayout.html

Demonstrates the fundamental setup of a GroupLayout for a JComponent, including enabling automatic gap creation.

```Java
JComponent panel = ...;
GroupLayout layout = new GroupLayout(panel);
panel.setLayout(layout);

// Turn on automatically adding gaps between components
layout.setAutoCreateGaps(true);

// Turn on automatically creating gaps between components that touch
// the edge of the container and the container.
layout.setAutoCreateContainerGaps(true);
```

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

### Get Start Position of Document

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/text/AbstractDocument.html

Returns a Position object representing the start of the document, which stays fixed at the beginning.

```java
public final Position getStartPosition()
```

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

### prepareForUIInstall()

Source: https://docs.oracle.com/javase/8/docs/api/index-files/index-16.html

Invoked after the `tree` instance variable has been set, but before any defaults/listeners have been installed. This method is part of the `BasicTreeUI` class.

```APIDOC
## prepareForUIInstall()

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

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### BasicSplitPaneUI.installDefaults()

Source: https://docs.oracle.com/javase/8/docs/api/index-files/index-9.html

Installs the UI defaults for JSplitPane.

```APIDOC
## installDefaults()

### Description
Installs the UI defaults.

### Method
`installDefaults`
```

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

### Get Gap Start Index in GapContent

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/text/GapContent.html

Provides access to the starting index of the gap within the storage array.

```java
protected final int getGapStart()
```

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

### Get JVM Start Time

Source: https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html

Retrieve the start time of the Java virtual machine in milliseconds since the epoch.

```java
long startTime = runtimeBean.getStartTime();
```

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

### installDefaults Method

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicDesktopIconUI.html

Installs the default values for the desktop icon.

```APIDOC
## installDefaults()

### Description
Installs the default values for the desktop icon.

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

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

### CubicCurve2D.Float - Get Start Point Y Coordinate

Source: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/CubicCurve2D.Float.html

Returns the Y coordinate of the start point of the cubic curve in double precision.

```java
public double getY1() 
```

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

### installDefaults

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/synth/SynthSplitPaneUI.html

Installs the UI defaults for the SynthSplitPaneUI.

```APIDOC
## installDefaults()

### Description
Installs the UI defaults.

### Method
`protected void installDefaults()`

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

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

### Getting Range Unit of Field

Source: https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalField.html

Gets the unit that the field is bound by. For example, in the field 'MonthOfYear', the range is 'Years'.

```java
TemporalUnit getRangeUnit()
```

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

### installUI Method

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicScrollPaneUI.html

Configures the component for the look and feel, including installing defaults, layout managers, sub-components, and listeners.

```java
public void installUI(JComponent x)
```

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

### installUI

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicSpinnerUI.html

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

```APIDOC
## installUI

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

### Method
void

### Parameters
#### Path Parameters
- **c** (JComponent) - The JSpinner to install the UI on.
```

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

### Getting Base Unit of Field

Source: https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalField.html

Gets the unit that the field is measured in. For example, in the field 'MonthOfYear', the unit is 'Months'.

```java
TemporalUnit getBaseUnit()
```

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

### SynthListUI.installDefaults()

Source: https://docs.oracle.com/javase/8/docs/api/index-files/index-9.html

Initializes list properties such as font, foreground, and background, and adds the CellRendererPane.

```APIDOC
## installDefaults()

### Description
Initializes list properties such as font, foreground, and background, and adds the CellRendererPane.

### Method
`installDefaults`
```

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

### Get Start Offset

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Element.html

Fetches the starting offset of the element within the document. For elements with children, this is the offset of the first child.

```java
int
getStartOffset()
```

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

### Get UI ActionMap for a Component

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/SwingUtilities.html

Retrieves the ActionMap installed by the UI for a given component. Returns null if no ActionMap is installed.

```Java
public static ActionMap getUIActionMap(JComponent component)
```

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

### Example of Initializing UIDefaults with Key-Value Pairs

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/UIDefaults.html

Demonstrates how to create a UIDefaults object by passing an array of key-value pairs. This example shows setting a Font, Color, and an Integer.

```java
Object[] uiDefaults = {
     "Font", new Font("Dialog", Font.BOLD, 12),
    "Color", Color.red,
     "five", new Integer(5)
}
UIDefaults myDefaults = new UIDefaults(uiDefaults);

```

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

### Get Selection Start - Java AWT TextComponent

Source: https://docs.oracle.com/javase/8/docs/api/java/awt/TextComponent.html

Retrieves the starting index of the currently selected text within this component.

```java
public int getSelectionStart()
```

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

### installDefaults

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/synth/SynthStyle.html

Installs the necessary state from this Style on the JComponent from context.

```APIDOC
## installDefaults

### Description
Installs the necessary state from this Style on the JComponent from context.

### Method
public void installDefaults(SynthContext context)

### Parameters
#### Path Parameters
- **context** (SynthContext) - SynthContext identifying component to install properties to.
```

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

### Install Defaults for JComponent

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicToolTipUI.html

Installs the default values for the JComponent. This method is part of the UI delegate's setup process.

```java
protected void installDefaults(JComponent c)
```

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

### Set up an Animated Image Source

Source: https://docs.oracle.com/javase/8/docs/api/java/awt/image/MemoryImageSource.html

This example demonstrates setting up an animated image source using MemoryImageSource. It initializes a pixel array, creates the source, marks it as animated, and then enters a loop to update pixel data and signal changes.

```java
int pixels[];
      MemoryImageSource source;

      public void init() {
          int width = 50;
          int height = 50;
          int size = width * height;
          pixels = new int[size];

          int value = getBackground().getRGB();
          for (int i = 0; i < size; i++) {
              pixels[i] = value;
          }

          source = new MemoryImageSource(width, height, pixels, 0, width);
          source.setAnimated(true);
          image = createImage(source);
      }

      public void run() {
          Thread me = Thread.currentThread( );
          me.setPriority(Thread.MIN_PRIORITY);

          while (true) {
              try {
                  Thread.sleep(10);
              } catch( InterruptedException e ) {
                  return;
              }

              // Modify the values in the pixels array at (x, y, w, h)

              // Send the new data to the interested ImageConsumers
              source.newPixels(x, y, w, h);
          }
      }
```

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

### getStartOffset

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/text/AbstractDocument.AbstractElement.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
public abstract int getStartOffset()

### Returns
the offset >= 0
```

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

### URL Protocol Handler Search Path Example

Source: https://docs.oracle.com/javase/8/docs/api/java/net/URL.html

Illustrates the search path for protocol handlers, starting with user-defined packages, then system properties, and finally system default packages.

```text
<_system default package_>.<_protocol_>.Handler
```

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

### installDefaults

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicColorChooserUI.html

Installs default settings for the UI delegate.

```APIDOC
## installDefaults

### Description
Installs default settings for the UI delegate.

### Method
protected void
```

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

### getPositiveSuffix

Source: https://docs.oracle.com/javase/8/docs/api/java/text/DecimalFormat.html

Get the positive suffix. Example: 123%

```APIDOC
## getPositiveSuffix

### Description
Get the positive suffix. Example: 123%

### Method
public String getPositiveSuffix()

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```java
// No explicit request body example provided in source.
```

### Response
#### Success Response
- **String** - the positive suffix

#### Response Example
```json
{
  "example": "// No explicit response example provided in source."
}
```
```

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

### getType Example

Source: https://docs.oracle.com/javase/8/docs/api/java/awt/Cursor.html

Demonstrates how to get the type of a cursor.

```APIDOC
## Method Detail

### getType

```java
public int getType()
```

Returns the type for this cursor.
```

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

### System.gc() Example

Source: https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryMXBean.html

Demonstrates the equivalent call to System.gc() for running the garbage collector.

```java
System.gc()

```

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

### getName Example

Source: https://docs.oracle.com/javase/8/docs/api/java/awt/Cursor.html

Demonstrates how to get the name of a cursor.

```APIDOC
## Method Detail

### getName

```java
public String getName()
```

Returns the name of this cursor.
```

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

### installUI(JComponent) - BasicListUI

Source: https://docs.oracle.com/javase/8/docs/api/index-files/index-9.html

Initializes `this.list` by calling `installDefaults()`, `installListeners()`, and `installKeyboardActions()` in order. Part of BasicListUI.

```APIDOC
## installUI(JComponent)

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

### Method
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
```

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

### Get Word Start Position

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Utilities.html

Determines the start of a word for a given model location in a JTextComponent. Useful for text selection and editing.

```Java
public static int getWordStart(JTextComponent c,
                                            int offs)
```

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

### initialize

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/LookAndFeel.html

Initializes the look and feel.

```APIDOC
## initialize()

### Description
Initializes the look and feel.

### Method
void
```

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

### installUI

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicListUI.html

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

```APIDOC
## installUI

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

### Method
public void installUI(JComponent c)

### Parameters
* `c` - the component where this UI delegate is being installed

### See Also
* `installDefaults()`
* `installListeners()`
* `installKeyboardActions()`
```

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

### Get Line Start Offset

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/JTextArea.html

Determines the starting offset of a given line number. Throws BadLocationException if the line number is invalid.

```Java
public int getLineStartOffset(int line)
                       throws BadLocationException
```

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

### installUI Method

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/metal/MetalFileChooserUI.html

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. This method should completely configure the component for the look and feel, including the following:
1. Install default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should _not_ be overridden.
2. Install a LayoutManager on the component if necessary.
3. Create/add any required sub-components to the component.
4. Create/install event listeners on the component.
5. Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately.
6. Install keyboard UI (mnemonics, traversal, etc.) on the component.
7. Initialize any appropriate instance data.

```APIDOC
## installUI Method

### 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. This method should completely configure the component for the look and feel, including the following:
1. Install default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should _not_ be overridden.
2. Install a `LayoutManager` on the component if necessary.
3. Create/add any required sub-components to the component.
4. Create/install event listeners on the component.
5. Create/install a `PropertyChangeListener` on the component in order to detect and respond to component property changes appropriately.
6. Install keyboard UI (mnemonics, traversal, etc.) on the component.
7. Initialize any appropriate instance data.

Overrides:
    `installUI` in class `BasicFileChooserUI`

Parameters:
    `c` - the component where this UI delegate is being installed
```

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

### Get Installed Login Configuration

Source: https://docs.oracle.com/javase/8/docs/api/javax/security/auth/login/Configuration.html

Retrieves the currently installed login configuration. If none has been explicitly set, it returns a default configuration.

```java
public static Configuration getConfiguration()
```

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

### Get the start index of the search region

Source: https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html

Reports the starting index (inclusive) of the region within the input sequence that this matcher searches.

```Java
public int regionStart()
```

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

### Complete UI Install

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicTreeUI.html

Invoked from installUI after all defaults and listeners have been successfully installed.

```java
protected void completeUIInstall()
```

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

### installDefaults

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/synth/SynthToolBarUI.html

Installs the default values for the SynthToolBarUI.

```APIDOC
## installDefaults()

### Description
Installs the default values for the SynthToolBarUI.

### Method
`protected void installDefaults()`

### Overrides
`installDefaults` in class `BasicToolBarUI`
```

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

### CodecSet Service Interface Example

Source: https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html

An example of a service interface, CodecSet, which is an abstract class with abstract methods for getting encoders and decoders.

```Java
public abstract Encoder getEncoder(String encodingName);
public abstract Decoder getDecoder(String encodingName);
```

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

### Get Start Index of a Run

Source: https://docs.oracle.com/javase/8/docs/api/java/text/Bidi.html

Returns the index of the first character of the nth logical run. This is an offset relative to the start of the line.

```java
int getRunStart(int run)
```

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

### installKeyboardActions Method

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicMenuItemUI.html

Installs the keyboard actions for the menu item.

```APIDOC
## installKeyboardActions()

### Description
Installs the keyboard actions for the menu item.

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

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

### installKeyboardActions

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicDesktopPaneUI.html

Installs the keyboard actions for the BasicDesktopPaneUI.

```APIDOC
## installKeyboardActions()

### Description
Installs the keyboard actions for the BasicDesktopPaneUI.

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

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

### Get Scanline Stride

Source: https://docs.oracle.com/javase/8/docs/api/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() {
    // Implementation details for retrieving scanline stride
    return 0; // Placeholder
}
```

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

### setupMenuCloseKey

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicInternalFrameUI.html

Sets up the key binding for closing the menu.

```APIDOC
## setupMenuCloseKey

### Description
Sets up the key binding for closing the menu.

### Method
`protected void`

### Signature
`setupMenuCloseKey()`
```

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

### CubicCurve2D.Float - Get Start Point X Coordinate

Source: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/CubicCurve2D.Float.html

Returns the X coordinate of the start point of the cubic curve in double precision.

```java
public double getX1() 
```

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

### Get LinearGradientPaint Start Point

Source: https://docs.oracle.com/javase/8/docs/api/java/awt/LinearGradientPaint.html

Returns a copy of the start point of the gradient axis. This point anchors the first color of the LinearGradientPaint.

```java
public Point2D getStartPoint()
```

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

### installDefaults

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/synth/SynthTextFieldUI.html

Initializes component properties such as font, foreground, background, caret color, selection color, and border color.

```APIDOC
## installDefaults

### Description
Initializes component properties, such as font, foreground, background, caret color, selection color, selected text color, disabled text color, and border color. The font, foreground, and background properties are only set if their current value is either null or a UIResource, other properties are set if the current value is null.

### Method
protected void

### Overrides
- `installDefaults` in class `BasicTextUI`

### See Also
- `BasicTextUI.uninstallDefaults()`
- `BasicTextUI.installUI(javax.swing.JComponent)`
```

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

### SwitchPoint Example

Source: https://docs.oracle.com/javase/8/docs/api/java/lang/invoke/SwitchPoint.html

Demonstrates how to use SwitchPoint to guard method handle invocations and invalidate them. This example shows the basic setup and usage of SwitchPoint.

```java
MethodHandle MH_strcat = MethodHandles.lookup()
    .findVirtual(String.class, "concat", MethodType.methodType(String.class, String.class));
SwitchPoint spt = new SwitchPoint();
assert(!spt.hasBeenInvalidated());
// the following steps may be repeated to re-use the same switch point:
MethodHandle worker1 = MH_strcat;
MethodHandle worker2 = MethodHandles.permuteArguments(MH_strcat, MH_strcat.type(), 1, 0);
MethodHandle worker = spt.guardWithTest(worker1, worker2);
assertEquals("method", (String) worker.invokeExact("met", "hod"));
SwitchPoint.invalidateAll(new SwitchPoint[]{ spt });
assert(spt.hasBeenInvalidated());
assertEquals("hodmet", (String) worker.invokeExact("met", "hod"));
```

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

### installDefaults

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/synth/SynthMenuItemUI.html

Installs the default properties for the UI.

```APIDOC
## installDefaults()

### Description
Installs the default properties for the UI.

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

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

### Service Provider Configuration File Example

Source: https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html

An example of a service provider configuration file, META-INF/services/com.example.CodecSet, which lists the fully-qualified binary names of concrete provider classes.

```Text
META-INF/services/com.example.CodecSet
```

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

### Get Row Start Position

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Utilities.html

Calculates the starting model position of the row containing a given offset in a JTextComponent. Requires the component to have a size.

```Java
public static final int getRowStart(JTextComponent c,
                                    int offs)
                             throws BadLocationException
```

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

### Get Row Start Position

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/text/Utilities.html

Determines the starting model position of the row containing a specified model position. Useful for line-based operations.

```Java
public static int getRowStart(JTextComponent c,
                                           int offs)
```

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

### Setting Initial Permissions

Source: https://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/PosixFileAttributeView.html

Demonstrates how to set initial POSIX permissions when creating a file.

```APIDOC
## Setting Initial Permissions

Implementations supporting `PosixFileAttributeView` may allow setting initial permissions during file or directory creation.

### Usage
Provide a `FileAttribute` with the name `"posix:permissions"` and the desired set of `PosixFilePermission` values to the `createFile` or `createDirectory` methods.

### Example
```java
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.attribute.PosixFilePermission;
import java.util.EnumSet;
import java.util.Set;

// ...
Path path = ...;
Set<PosixFilePermission> perms = EnumSet.of(PosixFilePermission.OWNER_READ, PosixFilePermission.OWNER_WRITE, PosixFilePermission.OWNER_EXECUTE, PosixFilePermission.GROUP_READ);
Files.createFile(path, PosixFilePermissions.asFileAttribute(perms));
```

### Note on Permissions
The actual permissions set on the file system may be less restrictive than requested due to factors like the system's `umask`.
```

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

### getRunStart (attributes)

Source: https://docs.oracle.com/javase/8/docs/api/java/text/AttributedCharacterIterator.html

Gets the start index of the current run for a set of attributes. This is useful for understanding the start of runs defined by multiple attributes.

```APIDOC
## getRunStart

### Description
Returns the index of the first character of the run with respect to the given `attributes` containing the current character.

### Method
`int`

### Endpoint
N/A (Interface Method)

### Parameters
- **attributes** (`Set<? extends AttributedCharacterIterator.Attribute>`) - A set of attributes to check for runs.

### Response
- **int** - The index of the first character of the run for the specified set of attributes.
```

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

### BasicToolTipUI.installDefaults(JComponent)

Source: https://docs.oracle.com/javase/8/docs/api/index-files/index-9.html

Installs default properties for JToolTip.

```APIDOC
## installDefaults(JComponent)

### Description
Installs default properties for JToolTip.

### Method
`installDefaults`

### Parameters
- **JComponent** (JComponent) - The JComponent to install defaults on.
```

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

### Getting Run Start for a Specific Attribute

Source: https://docs.oracle.com/javase/8/docs/api/java/text/AttributedCharacterIterator.html

Retrieves the starting index of the run for a specific attribute. This is useful for analyzing attribute-specific text segments.

```java
int
getRunStart(AttributedCharacterIterator.Attribute
attribute)
```

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

### Java NIO Files newByteChannel Examples

Source: https://docs.oracle.com/javase/8/docs/api/java/nio/file/Files.html

Demonstrates opening files for reading, appending to existing files (creating if necessary), and creating new files with specific permissions for both reading and writing.

```Java
     Path path = ...

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

```Java
     // 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));
```

```Java
     // 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);
```

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

### Get Substring from Start to End of Sequence

Source: https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html

Returns a new String containing a subsequence of characters from the specified start index to the end of the sequence.

```Java
public String substring(int start)
```

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

### installPreviewPanel Method

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicColorChooserUI.html

Installs the preview panel for the UI delegate.

```Java
protected
void
installPreviewPanel()
```

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

### Install Defaults

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/synth/SynthStyle.html

Installs the necessary state from this Style onto the JComponent associated with the SynthContext.

```Java
public void installDefaults(SynthContext context)
```

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

### Get Substring from Start to End

Source: https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html

Returns a new String containing a subsequence of characters from the specified start index to the end index (exclusive).

```Java
public String substring(int start,
                        int end)
```

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

### RowFilter Example: Include Entries Starting with 'a'

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/RowFilter.html

This example demonstrates how to implement an include method for a RowFilter to display only entries where at least one column's string value starts with the letter 'a'. It iterates through all columns of an entry and returns true if a match is found, otherwise false.

```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;
  }
 };
```

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

### installDefaults Method

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicFileChooserUI.html

Installs the default properties for the file chooser.

```Java
protected
void installDefaults(JFileChooser fc)
```

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

### installKeyboardActions

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicDesktopPaneUI.html

Installs the keyboard actions.

```APIDOC
## installKeyboardActions()

### Description
Installs the keyboard actions.

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

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

### Get Generic Listeners from DefaultTreeModel

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/tree/DefaultTreeModel.html

Returns an array of all listeners of a specified type registered with the model. For example, to get all `TreeModelListener`s, use `m.getListeners(TreeModelListener.class)`.

```java
public <T extends EventListener> T[] getListeners(Class<T> listenerType)
```

```java
TreeModelListener[] tmls = (TreeModelListener[])(m.getListeners(TreeModelListener.class));
```

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

### installComponents Method

Source: https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicMenuItemUI.html

Installs the necessary components for the menu item.

```APIDOC
## installComponents(JMenuItem menuItem)

### Description
Installs the necessary components for the menu item.

### Method
protected void installComponents(JMenuItem menuItem)

### Parameters
#### Path Parameters
- **menuItem** (JMenuItem) - The menu item to install components on.
```

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

### Get Thread CPU Time (Example)

Source: https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadMXBean.html

Demonstrates how to get the CPU time for a specific thread ID. This is a common pattern for monitoring thread performance.

```Java
getThreadCpuTime(Thread.currentThread().getId());

```

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

### installListeners() - BasicSplitPaneUI

Source: https://docs.oracle.com/javase/8/docs/api/index-files/index-9.html

Installs the event listeners for the UI.

```APIDOC
## installListeners() BasicSplitPaneUI

### Description
Installs the event listeners for the UI.

### Method
(Not specified, likely a method call within the Java API)

### Endpoint
(Not applicable, this is a Java method)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(Not applicable)

### Response
#### Success Response
(None)

#### Response Example
(Not applicable)
```

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

### Producer-Consumer Example with BlockingQueue

Source: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/BlockingQueue.html

A usage example demonstrating a typical producer-consumer scenario using a BlockingQueue. This setup can safely handle multiple producers and consumers.

```java
 class Producer implements Runnable {
   private final BlockingQueue queue;
   Producer(BlockingQueue q) { queue = q; }
   public void run() {
     try {
       while (true) { queue.put(produce()); }
     } catch (InterruptedException ex) { ... handle ...}
   }
   Object produce() { ... }
 }

 class Consumer implements Runnable {
   private final BlockingQueue queue;
   Consumer(BlockingQueue q) { queue = q; }
   public void run() {
     try {
       while (true) { consume(queue.take()); }
     } catch (InterruptedException ex) { ... handle ...}
   }
   void consume(Object x) { ... }
 }

 class Setup {
   void main() {
     BlockingQueue q = new SomeQueueImplementation();
     Producer p = new Producer(q);
     Consumer c1 = new Consumer(q);
     Consumer c2 = new Consumer(q);
     new Thread(p).start();
     new Thread(c1).start();
     new Thread(c2).start();
   }
 }
```

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

### GetTimeResponse Implementation Example

Source: https://docs.oracle.com/javase/8/docs/api/javax/naming/ldap/ExtendedRequest.html

Example implementation of an ExtendedResponse for a 'get time' operation. This class decodes the response value and provides methods to retrieve the time.

```java
public class GetTimeResponse implements ExtendedResponse {
    long time;
    public GetTimeResponse(String id, byte[] berValue, int offset,
        int length) throws NamingException {
        time =      ... // decode berValue to get time
    }
    public java.util.Date getDate() { return new java.util.Date(time) };
    public long getTime() { return time };
    ...
 }
```
Tokens:
Raw