Module it.tidalwave.util
Package it.tidalwave.util

Interface PreferencesHandler

public interface PreferencesHandler
Since:
3.2-ALPHA-17
Author:
Fabrizio Giudici

  • Field Details

    • PROPS_BASE_NAME

      static final String PROPS_BASE_NAME

    • PROP_APP_NAME

      static final String PROP_APP_NAME

    • PROP_SUPPRESS_CONSOLE

      static final String PROP_SUPPRESS_CONSOLE
      Suppress any console output. @since 3.2-ALPHA-21

  • Method Details

    • getInstance

      @Nonnull static PreferencesHandler getInstance()
      Returns a singleton instance.
      Returns:
      the singleton instance

    • getAppFolder

      @Nonnull Path getAppFolder()
      Returns the path of the folder where files related to the app should go.
      Returns:
      the path

    • getLogFolder

      @Nonnull Path getLogFolder()
      Returns the path of the folder where logs should go.
      Returns:
      the path

    • setAppName

      static void setAppName(@Nonnull String name)
      Sets the application name. This method must be called at boot from the main method before doing anything else.
      Parameters:
      name - the property name

    • getProperty

      @Nonnull <T> Optional<T> getProperty(@Nonnull Key<T> name)
      Gets a property.
      Type Parameters:
      T - the property type
      Parameters:
      name - the property name
      Returns:
      the property value

    • setProperty

      <T> void setProperty(@Nonnull Key<T> name, @Nonnull T value)
      Sets a property, overriding the current value.
      Type Parameters:
      T - the property type
      Parameters:
      name - the property name
      value - the property value

    • setDefaultProperty

      <T> void setDefaultProperty(@Nonnull Key<T> name, @Nonnull T value)
      Sets a property, unless it has been already set.
      Type Parameters:
      T - the property type
      Parameters:
      name - the property name
      value - the property value