Module omix.api
Package omix.plugin.util

Interface Settings

public interface Settings
This interface allows to store and read properties in the Omix settings file.
Since:
Omix 1.3.11
Author:
Dr. Peter Droste, Omix Visualization

  • Method Summary

    Modifier and Type Method Description
    boolean contains​(String identifier)
    Determines if the key (identifier) exists in the settings file.
    boolean contains​(String group, String identifier)
    Determines if the key (group\identifier) exists in the settings file.
    void removeValue​(String identifier)
    Removes the key (identifier) value pair from the settings file
    void removeValue​(String group, String identifier)
    Removes the key (group\identifier) value pair from the settings file
    void setValue​(String identifier, Object value)
    save the value with the key group\identifier.
    void setValue​(String group, String identifier, Object value)
    save the value with the key group\identifier.
    Object value​(String identifier)
    The same as value(null, identifier)
    Object value​(String identifier, Object defaultValue)
    Read the value at key group\identifier.
    Object value​(String group, String identifier)
    The same as value(group, identifier, null)
    Object value​(String group, String identifier, Object defaultValue)
    Read the value at key group\identifier.

  • Method Details

    • setValue

      void setValue​(String identifier, Object value)
      save the value with the key group\identifier. Equivalent to setValue(null, identifier, value).
      Parameters:
      identifier -
      value -
      See Also:
      setValue(String, String, Object)

    • setValue

      void setValue​(String group, String identifier, Object value)
      save the value with the key group\identifier.
      Parameters:
      group -
      identifier -
      value -

    • value

      Object value​(String identifier)
      The same as value(null, identifier)
      Parameters:
      identifier -
      Returns:
      value

    • value

      Object value​(String identifier, Object defaultValue)
      Read the value at key group\identifier. The same as value(null, identifier, defaultValue)
      Parameters:
      identifier -
      defaultValue -
      Returns:
      if exists: the value or 'defaultValue' otherwise

    • value

      Object value​(String group, String identifier)
      The same as value(group, identifier, null)
      Parameters:
      group -
      identifier -
      Returns:
      value

    • value

      Object value​(String group, String identifier, Object defaultValue)
      Read the value at key group\identifier.
      Parameters:
      group -
      identifier -
      defaultValue -
      Returns:
      if exists: the value or 'defaultValue' otherwise

    • removeValue

      void removeValue​(String identifier)
      Removes the key (identifier) value pair from the settings file
      Parameters:
      identifier -

    • removeValue

      void removeValue​(String group, String identifier)
      Removes the key (group\identifier) value pair from the settings file
      Parameters:
      group -
      identifier -

    • contains

      boolean contains​(String identifier)
      Determines if the key (identifier) exists in the settings file.
      Parameters:
      identifier -
      Returns:
      true if 'identifier' exists

    • contains

      boolean contains​(String group, String identifier)
      Determines if the key (group\identifier) exists in the settings file.
      Parameters:
      group -
      identifier -
      Returns:
      true if 'group\identifier' exists