Package io.jmix.appsettings

Interface AppSettingsTools

All Known Implementing Classes:
AppSettingsToolsImpl
@NullMarked public interface AppSettingsTools

  • Method Details

    • loadAppSettingsEntityFromDataStore

      default <T extends AppSettingsEntity> T loadAppSettingsEntityFromDataStore(Class<T> clazz)
      Loads application settings entity by its clazz from data store for reading.
      Parameters:
      clazz - class that extends AppSettingsEntity
      Returns:
      application settings entity

    • loadAppSettingsEntityFromDataStore

      default <T extends AppSettingsEntity> T loadAppSettingsEntityFromDataStore(Class<T> clazz, boolean softDeletion)
      Loads application settings entity by its clazz from data store for reading.
      Parameters:
      clazz - class that extends AppSettingsEntity
      softDeletion - whether soft-deleted entities should be filtered out
      Returns:
      application settings entity

    • loadAppSettingsEntityFromDataStore

      default <T extends AppSettingsEntity> T loadAppSettingsEntityFromDataStore(Class<T> clazz, AppSettingsEntityLoadMode mode)
      Loads application settings entity by its clazz from data store according to provided AppSettingsEntityLoadMode.
      Parameters:
      clazz - class that extends AppSettingsEntity
      mode - load mode
      Returns:
      application settings entity

    • loadAppSettingsEntityFromDataStore

      <T extends AppSettingsEntity> T loadAppSettingsEntityFromDataStore(Class<T> clazz, AppSettingsEntityLoadMode mode, boolean softDeletion)
      Loads application settings entity by its clazz from data store according to provided AppSettingsEntityLoadMode and soft deletion hint.
      Parameters:
      clazz - class that extends AppSettingsEntity
      mode - load mode
      softDeletion - whether soft-deleted entities should be filtered out
      Returns:
      application settings entity

    • getPropertyValue

      @Nullable Object getPropertyValue(Class<? extends AppSettingsEntity> clazz, String propertyName)
      Returns actual value for provided propertyName and clazz.
      Parameters:
      clazz - class that extends AppSettingsEntity
      propertyName - property name for which value should be calculated
      Returns:
      actual value of provided propertyName

    • getDefaultPropertyValue

      @Nullable Object getDefaultPropertyValue(Class<? extends AppSettingsEntity> clazz, String propertyName)
      Returns default value for provided propertyName and clazz based on value of one of the AppSettingsDefault annotation.
      Parameters:
      clazz - class that extends AppSettingsEntity
      propertyName - property name for which default value should be calculated
      Returns:
      value by default of provided propertyName

    • getPropertyNames

      <T extends AppSettingsEntity> List<String> getPropertyNames(Class<T> clazz)
      Returns all non-system properties' names for given clazz.
      Parameters:
      clazz - class that extends AppSettingsEntity
      Returns:
      non-system properties' names for given clazz