Package com.atlassian.bamboo.collections

Interface ActionParametersMap

All Superinterfaces:
Map<String,Object>
All Known Implementing Classes:
ActionParametersMapImpl, SimpleActionParametersMap
public interface ActionParametersMap extends Map<String,Object>

  • Method Details

    • getString

      @Nullable @Nullable String getString(@Nullable @Nullable String key)
      Returns a String value from the map of parameters. If the key does not exist in the map, then null is returned.
      Parameters:
      key - Key of value to be searched in the map
      Returns:
      String value of object found or null if not found

    • getString

      @NotNull @NotNull String getString(@Nullable @Nullable String key, @NotNull @NotNull String defaultString)
      Returns a String value from the map of parmeters. If the key does not exist in the map or the value is null then the defaultString is returned.
      Parameters:
      key - Key of value to be searched in the map
      defaultString - the default string to return if the property does not exist in the map
      Returns:
      String value of object found or defaultString if not found

    • getStringArray

      @Nullable @Nullable String[] getStringArray(@Nullable @Nullable String key)
      Returns a String[] value from the map of parameters. If the key does not exist in the map, then null is returned.
      Parameters:
      key - Key of value to be searched in the map
      Returns:
      String[] value of object found or null if not found

    • getInt

      int getInt(@Nullable @Nullable String key, int defaultValue)
      Retrieve Integer value from the map of parameters. If the key does not exist in the map, or is not convertible to Integer then default value is returned.
      Parameters:
      key - Key of value to be searched in the map
      defaultValue - Default value to be returned if key not found or not convertible to Integer
      Returns:
      Value of object found or defaultValue if not convertible to Integer or not found

    • getLong

      long getLong(@Nullable @Nullable String key, long defaultValue)
      Retrieve Long value from the map of parameters. If the key does not exist in the map, or is not convertible to Long then default value is returned.
      Parameters:
      key - Key of value to be searched in the map
      defaultValue - Default value to be returned if key not found or not convertible to Long
      Returns:
      Value of object found or defaultValue if not convertible to Long or not found

    • getDouble

      double getDouble(@Nullable @Nullable String key, double defaultValue)
      Retrieve Double value from the map of parameters. If the key does not exist in the map, or is not convertible to Double then default value is returned.
      Parameters:
      key - Key of value to be searched in the map
      defaultValue - Default value to be returned if key not found or not convertible to Double
      Returns:
      Value of object found or defaultValue if not convertible to Double or not found

    • getBoolean

      boolean getBoolean(@Nullable @Nullable String key)
      Returns a boolean value from the map of parameters. If it does not exist in the map, then false is returned
      Parameters:
      key - Key of value to be searched in the map
      Returns:
      True if the value converted to true or false otherwise

    • getBoolean

      boolean getBoolean(@Nullable @Nullable String key, boolean defaultValue)
      Returns a boolean value from the map of parameters. If it does not exist in the map, then defaultValue is returned
      Parameters:
      key - Key of value to be searched in the map
      Returns:
      True if the value converted to true, false if the value converted to false, defaultValue otherwise

    • getFiles

      @NotNull @NotNull Map<String,File> getFiles()
      Returns map of Files uploaded to this form.
      Returns:
      Map of Files uploaded to this form

    • getParameters

      Map<String,Object> getParameters()
      Returns internal map of parameters.
      Returns:
      Parameters map