Package net.solarnetwork.node.settings

Interface FileSettingSpecifier

All Superinterfaces:
net.solarnetwork.settings.KeyedSettingSpecifier<org.springframework.core.io.Resource>, net.solarnetwork.settings.MappableSpecifier, net.solarnetwork.settings.SettingSpecifier
All Known Implementing Classes:
BasicFileSettingSpecifier
public interface FileSettingSpecifier extends net.solarnetwork.settings.KeyedSettingSpecifier<org.springframework.core.io.Resource>
A file-upload setting specifier.

This API is designed to work with the SettingResourceHandler API. A SettingSpecifierProvider would expose a FileSettingSpecifier while also implementing SettingResourceHandler to accept external configuration resources.

Since:
1.70
Version:
2.0
Author:
matt

  • Nested Class Summary

    Nested classes/interfaces inherited from interface net.solarnetwork.settings.MappableSpecifier

    net.solarnetwork.settings.MappableSpecifier.Mapper

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getAcceptableFileTypeSpecifiers()
    Get a set of file type specifiers this specifier can accept.
    boolean
    isMultiple()
    Flag indicating if multiple files can be accepted by this setting.

    Methods inherited from interface net.solarnetwork.settings.KeyedSettingSpecifier

    getDefaultValue, getDescriptionArguments, getKey, isTransient

    Methods inherited from interface net.solarnetwork.settings.MappableSpecifier

    mappedTo, mappedWithMapper, mappedWithPlaceholer

    Methods inherited from interface net.solarnetwork.settings.SettingSpecifier

    getTitle, getType

  • Method Details

    • getAcceptableFileTypeSpecifiers

      Set<String> getAcceptableFileTypeSpecifiers()
      Get a set of file type specifiers this specifier can accept.

      A file type specifier can be either a file name extension, starting with a period character, or a MIME type, including those with a wildcard subtype. For example .jpg, image/jpg, and image/* are valid values.

      If the returned value is null or empty, then all file types are acceptable.

      Returns:
      the set of acceptable types

    • isMultiple

      boolean isMultiple()
      Flag indicating if multiple files can be accepted by this setting.
      Returns:
      true if multiple files are acceptable