Package com.activeviam.properties

Interface IActiveViamPropertyRegistry

All Known Implementing Classes:
ActiveViamPropertyRegistry
public interface IActiveViamPropertyRegistry
Interface to handle the Properties defined in ActiveViam products.
Author:
ActiveViam

  • Method Details

    • getString

      String getString(IActiveViamProperty prop, String defaultValue)
      Gets the value of the property or defaultValue if it is not defined.
      Parameters:
      prop - the property to resolve
      defaultValue - the default value to return if no value is found
      Returns:
      the value of the property or defaultValue if it is not defined

    • getRequiredString

      String getRequiredString(IActiveViamProperty prop) throws IllegalStateException
      Gets the value of the property (never null).
      Parameters:
      prop - the property to resolve
      Returns:
      the value of the property as a string
      Throws:
      IllegalStateException - if the property is not defined

    • getBoolean

      boolean getBoolean(IActiveViamProperty prop, boolean defaultValue)
      Gets the value of the property or defaultValue if it is not defined.
      Parameters:
      prop - the property to resolve
      defaultValue - the default value to return if no value is found
      Returns:
      the value of the property or defaultValue if it is not defined

    • getRequiredBoolean

      boolean getRequiredBoolean(IActiveViamProperty prop) throws IllegalStateException
      Gets the value of the property.
      Parameters:
      prop - the property to resolve
      Returns:
      the value of the property
      Throws:
      IllegalStateException - if the property is not defined

    • getInteger

      int getInteger(IActiveViamProperty prop, int defaultValue)
      Gets the value of the property or defaultValue if it is not defined.
      Parameters:
      prop - the property to resolve
      defaultValue - the default value to return if no value is found
      Returns:
      the value of the property or defaultValue if it is not defined

    • getRequiredInteger

      int getRequiredInteger(IActiveViamProperty prop) throws IllegalStateException
      Gets the value of the property.
      Parameters:
      prop - the property to resolve
      Returns:
      the value of the property
      Throws:
      IllegalStateException - if the property is not defined

    • getDouble

      double getDouble(IActiveViamProperty prop, double defaultValue)
      Gets the value of the property or defaultValue if it is not defined.
      Parameters:
      prop - the property to resolve
      defaultValue - the default value to return if no value is found
      Returns:
      the value of the property or defaultValue if it is not defined

    • getRequiredDouble

      double getRequiredDouble(IActiveViamProperty prop) throws IllegalStateException
      Gets the value of the property.
      Parameters:
      prop - the property to resolve
      Returns:
      the value of the property
      Throws:
      IllegalStateException - if the property is not defined

    • getLong

      long getLong(IActiveViamProperty prop, long defaultValue)
      Gets the value of the property or defaultValue if it is not defined.
      Parameters:
      prop - the property to resolve
      defaultValue - the default value to return if no value is found
      Returns:
      the value of the property or defaultValue if it is not defined

    • getRequiredLong

      long getRequiredLong(IActiveViamProperty prop) throws IllegalStateException
      Gets the value of the property.
      Parameters:
      prop - the property to resolve
      Returns:
      the value of the property
      Throws:
      IllegalStateException - if the property is not defined

    • set

      void set(IActiveViamProperty prop, Object value)
      Sets the value of a property.
      Parameters:
      prop - the property to set in the registry
      value - value to set in the registry

    • clear

      void clear(IActiveViamProperty prop)
      Resets the value of a property.
      Parameters:
      prop - the property to clear