Package net.solarnetwork.settings

Interface MappableSpecifier

All Known Subinterfaces:
CronExpressionSettingSpecifier, GroupSettingSpecifier, KeyedSettingSpecifier<T>, MultiValueSettingSpecifier, RadioGroupSettingSpecifier, SliderSettingSpecifier, TextAreaSettingSpecifier, TextFieldSettingSpecifier, TitleSettingSpecifier, ToggleSettingSpecifier
All Known Implementing Classes:
BaseKeyedSettingSpecifier, BasicCronExpressionSettingSpecifier, BasicGroupSettingSpecifier, BasicMultiValueSettingSpecifier, BasicRadioGroupSettingSpecifier, BasicSliderSettingSpecifier, BasicTextAreaSettingSpecifier, BasicTextFieldSettingSpecifier, BasicTitleSettingSpecifier, BasicToggleSettingSpecifier
public interface MappableSpecifier
API for a specifier that can be mapped to some other specifier.
Version:
1.0
Author:
matt

  • Method Details

    • mappedTo

      SettingSpecifier mappedTo(String prefix)
      Return a setting specifier mapped to a new path.

      This is to allow delegating setting specifiers to re-map the key.

      Parameters:
      prefix - the new prefix to add to the key
      Returns:
      the new instance

    • mappedWithPlaceholer

      SettingSpecifier mappedWithPlaceholer(String template)
      Return a setting specifier mapped to a new path, using a format template.
      Parameters:
      template - the format template
      Returns:
      the new instance

    • mappedWithMapper

      SettingSpecifier mappedWithMapper(MappableSpecifier.Mapper mapper)
      Return a setting specifier mapped to a new path, using a MappableSpecifier.Mapper.
      Parameters:
      mapper - the mapper
      Returns:
      the new instance

    • mapTo

      static List<SettingSpecifier> mapTo(List<SettingSpecifier> settings, String prefix)
      Map a list of settings to a new prefix.
      Parameters:
      settings - the settings to map
      prefix - the prefix to add to each setting
      Returns:
      the mapped settings
      Since:
      1.1

    • mapWithPlaceholder

      static List<SettingSpecifier> mapWithPlaceholder(List<SettingSpecifier> settings, String template)
      Map a list of settings with a template.
      Parameters:
      settings - the settings to map
      template - the template to use
      Returns:
      the mapped settings
      Since:
      1.1

    • mapWithMapper

      static List<SettingSpecifier> mapWithMapper(List<SettingSpecifier> settings, MappableSpecifier.Mapper mapper)
      Map a list of settings with a Mapper.
      Parameters:
      settings - the settings to map
      mapper - the Mapper to use
      Returns:
      the mapped settings
      Since:
      1.1