Package net.solarnetwork.node.settings.support

Class BasicFileSettingSpecifier

java.lang.Object
net.solarnetwork.settings.support.BaseSettingSpecifier
net.solarnetwork.settings.support.BaseKeyedSettingSpecifier<org.springframework.core.io.Resource>
net.solarnetwork.node.settings.support.BasicFileSettingSpecifier
All Implemented Interfaces:
FileSettingSpecifier, net.solarnetwork.settings.KeyedSettingSpecifier<org.springframework.core.io.Resource>, net.solarnetwork.settings.MappableSpecifier, net.solarnetwork.settings.SettingSpecifier
public class BasicFileSettingSpecifier extends net.solarnetwork.settings.support.BaseKeyedSettingSpecifier<org.springframework.core.io.Resource> implements FileSettingSpecifier
Basic implementation of FileSettingSpecifier.
Version:
2.0
Author:
matt

  • Nested Class Summary

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

    net.solarnetwork.settings.MappableSpecifier.Mapper

  • Constructor Summary

    Constructors
    Constructor
    Description
    BasicFileSettingSpecifier(String key, org.springframework.core.io.Resource defaultValue)
    Constructor.
    BasicFileSettingSpecifier(String key, org.springframework.core.io.Resource defaultValue, Set<String> acceptableFileTypeSpecifiers, boolean multiple)
    Constructor.

  • 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.
    net.solarnetwork.settings.SettingSpecifier
    mappedWithMapper(net.solarnetwork.settings.MappableSpecifier.Mapper mapper)
     
    net.solarnetwork.settings.SettingSpecifier
    mappedWithPlaceholer(String template)
     

    Methods inherited from class net.solarnetwork.settings.support.BaseKeyedSettingSpecifier

    getDefaultValue, getDescriptionArguments, getKey, isTransient, mappedTo, setDefaultValue, setDescriptionArguments, setKey, setTransient, toString

    Methods inherited from class net.solarnetwork.settings.support.BaseSettingSpecifier

    getTitle, getType, setTitle

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface net.solarnetwork.settings.KeyedSettingSpecifier

    getDefaultValue, getDescriptionArguments, getKey, isTransient

    Methods inherited from interface net.solarnetwork.settings.MappableSpecifier

    mappedTo

    Methods inherited from interface net.solarnetwork.settings.SettingSpecifier

    getTitle, getType

  • Constructor Details

    • BasicFileSettingSpecifier

      public BasicFileSettingSpecifier(String key, org.springframework.core.io.Resource defaultValue)
      Constructor.

      This sets acceptableFileTypeSpecifiers to null and multiple to false.

      Parameters:
      key - the key
      defaultValue - the default value

    • BasicFileSettingSpecifier

      public BasicFileSettingSpecifier(String key, org.springframework.core.io.Resource defaultValue, Set<String> acceptableFileTypeSpecifiers, boolean multiple)
      Constructor.
      Parameters:
      key - the key
      defaultValue - the default value
      acceptableFileTypeSpecifiers - the acceptable file type specifiers, or null if all files are acceptable
      multiple - true if multiple files can be accepted, false if only a single file is acceptable

  • Method Details

    • mappedWithPlaceholer

      public net.solarnetwork.settings.SettingSpecifier mappedWithPlaceholer(String template)
      Specified by:
      mappedWithPlaceholer in interface net.solarnetwork.settings.MappableSpecifier

    • mappedWithMapper

      public net.solarnetwork.settings.SettingSpecifier mappedWithMapper(net.solarnetwork.settings.MappableSpecifier.Mapper mapper)
      Specified by:
      mappedWithMapper in interface net.solarnetwork.settings.MappableSpecifier

    • getAcceptableFileTypeSpecifiers

      public Set<String> getAcceptableFileTypeSpecifiers()
      Description copied from interface: FileSettingSpecifier
      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.

      Specified by:
      getAcceptableFileTypeSpecifiers in interface FileSettingSpecifier
      Returns:
      the set of acceptable types

    • isMultiple

      public boolean isMultiple()
      Description copied from interface: FileSettingSpecifier
      Flag indicating if multiple files can be accepted by this setting.
      Specified by:
      isMultiple in interface FileSettingSpecifier
      Returns:
      true if multiple files are acceptable