loci.plugins.prefs

## Class BooleanOption

- java.lang.Object
- - loci.plugins.prefs.Option
  - - loci.plugins.prefs.BooleanOption

-     public class BooleanOption
      extends Option

  A boolean option for one of the plugins.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected boolean` | `defaultValue` The option's default value.
    `protected boolean` | `value` The option's current value.

    - ### Fields inherited from class loci.plugins.prefs.Option

      `info, INI_DEFAULT, INI_INFO, INI_KEY, INI_LABEL, INI_SAVE, key, KEY_PREFIX, label, save`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `BooleanOption(java.util.HashMap<java.lang.String,java.lang.String> entry)` Constructs a boolean option with the parameters from the given map.
    `BooleanOption(java.lang.String key, boolean save, java.lang.String label, java.lang.String info, boolean defaultValue)` Constructs a boolean option with the given parameters.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `getDefault()` Gets the default value of the option.
    `boolean` | `getValue()` Gets the current value of the option.
    `void` | `loadOption()` Loads the option's value from the ImageJ preferences file.
    `void` | `parseOption(java.lang.String arg)` Parses the option's value from the given argument string.
    `void` | `saveOption()` Saves the option's value to the ImageJ preferences file.
    `void` | `setValue(boolean value)` Sets the current value of the option.

    - ### Methods inherited from class loci.plugins.prefs.Option

      `getInfo, getKey, getLabel, isSaved`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### defaultValue

          protected boolean defaultValue

      The option's default value.

    - #### value

          protected boolean value

      The option's current value.

  - ### Constructor Detail

    - #### BooleanOption

          public BooleanOption(java.util.HashMap<java.lang.String,java.lang.String> entry)

      Constructs a boolean option with the parameters from the given map.

    - #### BooleanOption

          public BooleanOption(java.lang.String key,
                               boolean save,
                               java.lang.String label,
                               java.lang.String info,
                               boolean defaultValue)

      Constructs a boolean option with the given parameters.

  - ### Method Detail

    - #### getDefault

          public boolean getDefault()

      Gets the default value of the option.

    - #### getValue

          public boolean getValue()

      Gets the current value of the option.

    - #### setValue

          public void setValue(boolean value)

      Sets the current value of the option.

    - #### parseOption

          public void parseOption(java.lang.String arg)

      Description copied from class: `Option`
      Parses the option's value from the given argument string.
      Specified by:
        `parseOption` in class `Option`

    - #### loadOption

          public void loadOption()

      Description copied from class: `Option`
      Loads the option's value from the ImageJ preferences file.
      Specified by:
        `loadOption` in class `Option`

    - #### saveOption

          public void saveOption()

      Description copied from class: `Option`
      Saves the option's value to the ImageJ preferences file.
      Specified by:
        `saveOption` in class `Option`

Copyright © 2026 Open Microscopy Environment