Interface TypableFileVariable

  • All Known Implementing Classes:
    TaskVariables

    public interface TypableFileVariable
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default java.lang.Boolean getBooleanFileVariable​(java.lang.String key, java.lang.String file)
      Retrieves the first match for the specified key and file or null if there is no match and casts it to a Boolean type.
      default java.lang.Boolean getBooleanFileVariable​(java.lang.String key, java.lang.String file, java.lang.Boolean defaultValue)
      Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a Boolean type.
      default java.lang.Double getDoubleFileVariable​(java.lang.String key, java.lang.String file)
      Retrieves the first match for the specified key and file or null if there is no match and casts it to a Double type.
      default java.lang.Double getDoubleFileVariable​(java.lang.String key, java.lang.String file, java.lang.Double defaultValue)
      Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a Double type.
      java.lang.Object getFileVariable​(java.lang.String key, java.lang.String file)
      Retrieves the first match for the specified key and file or null if there is no match found.
      default java.lang.Integer getIntegerFileVariable​(java.lang.String key, java.lang.String file)
      Retrieves the first match for the specified key and file or null if there is no match and casts it to a Integer type.
      default java.lang.Integer getIntegerFileVariable​(java.lang.String key, java.lang.String file, java.lang.Integer defaultValue)
      Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a Integer type.
      default java.util.List<java.lang.Object> getListFileVariable​(java.lang.String key, java.lang.String file)
      Retrieves the first match for the specified key and file or null if there is no match and casts it to a List type.
      default java.util.List<java.lang.Object> getListFileVariable​(java.lang.String key, java.lang.String file, java.util.List<java.lang.Object> defaultValue)
      Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a List type.
      default java.util.List<java.lang.String> getListStringFileVariable​(java.lang.String key, java.lang.String file)
      Retrieves the first match for the specified key and file or null if there is no match and casts it to a List type.
      default java.util.List<java.lang.String> getListStringFileVariable​(java.lang.String key, java.lang.String file, java.util.List<java.lang.String> defaultValue)
      Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a List type.
      default java.util.Map<java.lang.String,​java.lang.Object> getMapFileVariable​(java.lang.String key, java.lang.String file)
      Retrieves the first match for the specified key and file or null if there is no match and casts it to a Map type.
      default java.util.Map<java.lang.String,​java.lang.Object> getMapFileVariable​(java.lang.String key, java.lang.String file, java.util.Map<java.lang.String,​java.lang.Object> defaultValue)
      Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a Map type.
      default java.util.Set<java.lang.Object> getSetFileVariable​(java.lang.String key, java.lang.String file)
      Retrieves the first match for the specified key and file or null if there is no match and casts it to a Set type.
      default java.util.Set<java.lang.Object> getSetFileVariable​(java.lang.String key, java.lang.String file, java.util.Set<java.lang.Object> defaultValue)
      Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a Set type.
      default java.util.Set<java.lang.String> getSetStringFileVariable​(java.lang.String key, java.lang.String file)
      Retrieves the first match for the specified key and file or null if there is no match and casts it to a Set type.
      default java.util.Set<java.lang.String> getSetStringFileVariable​(java.lang.String key, java.lang.String file, java.util.Set<java.lang.String> defaultValue)
      Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a Set type.
      default java.lang.String getStringFileVariable​(java.lang.String key, java.lang.String file)
      Retrieves the first match for the specified key and file or null if there is no match and casts it to a String type.
      default java.lang.String getStringFileVariable​(java.lang.String key, java.lang.String file, java.lang.String defaultValue)
      Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a String type.
    • Method Detail

      • getFileVariable

        java.lang.Object getFileVariable​(java.lang.String key,
                                         java.lang.String file)
                                  throws BuildException
        Retrieves the first match for the specified key and file or null if there is no match found.
        Parameters:
        key - the key to match.
        file - the file to match.
        Returns:
        Object or null if no match is found.
        Throws:
        BuildException
      • getBooleanFileVariable

        default java.lang.Boolean getBooleanFileVariable​(java.lang.String key,
                                                         java.lang.String file)
                                                  throws BuildException
        Retrieves the first match for the specified key and file or null if there is no match and casts it to a Boolean type. Replacing all references in the process.
        Parameters:
        key - the key to match.
        file - the file to match.
        Returns:
        Boolean or null if no match is found.
        Throws:
        BuildException - if the typecast fails
      • getBooleanFileVariable

        default java.lang.Boolean getBooleanFileVariable​(java.lang.String key,
                                                         java.lang.String file,
                                                         java.lang.Boolean defaultValue)
                                                  throws BuildException
        Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a Boolean type. Replacing all references in the process.
        Parameters:
        key - the key to match.
        file - the file to match.
        defaultValue - the default value to return if there is no match.
        Returns:
        Boolean or defaultValue if no match is found.
        Throws:
        BuildException - if the typecast fails
      • getStringFileVariable

        default java.lang.String getStringFileVariable​(java.lang.String key,
                                                       java.lang.String file,
                                                       java.lang.String defaultValue)
                                                throws BuildException
        Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a String type. Replacing all references in the process.
        Parameters:
        key - the key to match.
        file - the file to match.
        defaultValue - the default value to return if there is no match.
        Returns:
        String or defaultValue if no match is found.
        Throws:
        BuildException - if the typecast fails
      • getStringFileVariable

        default java.lang.String getStringFileVariable​(java.lang.String key,
                                                       java.lang.String file)
                                                throws BuildException
        Retrieves the first match for the specified key and file or null if there is no match and casts it to a String type. Replacing all references in the process.
        Parameters:
        key - the key to match.
        file - the file to match.
        Returns:
        String or null if no match is found.
        Throws:
        BuildException - if the typecast fails
      • getIntegerFileVariable

        default java.lang.Integer getIntegerFileVariable​(java.lang.String key,
                                                         java.lang.String file,
                                                         java.lang.Integer defaultValue)
                                                  throws BuildException
        Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a Integer type. Replacing all references in the process.
        Parameters:
        key - the key to match.
        file - the file to match.
        defaultValue - the default value to return if there is no match.
        Returns:
        Integer or defaultValue if no match is found.
        Throws:
        BuildException - if the typecast fails
      • getIntegerFileVariable

        default java.lang.Integer getIntegerFileVariable​(java.lang.String key,
                                                         java.lang.String file)
                                                  throws BuildException
        Retrieves the first match for the specified key and file or null if there is no match and casts it to a Integer type. Replacing all references in the process.
        Parameters:
        key - the key to match.
        file - the file to match.
        Returns:
        Integer or null if no match is found.
        Throws:
        BuildException - if the typecast fails
      • getDoubleFileVariable

        default java.lang.Double getDoubleFileVariable​(java.lang.String key,
                                                       java.lang.String file,
                                                       java.lang.Double defaultValue)
                                                throws BuildException
        Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a Double type. Replacing all references in the process.
        Parameters:
        key - the key to match.
        file - the file to match.
        defaultValue - the default value to return if there is no match.
        Returns:
        Double or defaultValue if no match is found.
        Throws:
        BuildException - if the typecast fails
      • getDoubleFileVariable

        default java.lang.Double getDoubleFileVariable​(java.lang.String key,
                                                       java.lang.String file)
                                                throws BuildException
        Retrieves the first match for the specified key and file or null if there is no match and casts it to a Double type. Replacing all references in the process.
        Parameters:
        key - the key to match.
        file - the file to match.
        Returns:
        Double or null if no match is found.
        Throws:
        BuildException - if the typecast fails
      • getListFileVariable

        default java.util.List<java.lang.Object> getListFileVariable​(java.lang.String key,
                                                                     java.lang.String file,
                                                                     java.util.List<java.lang.Object> defaultValue)
                                                              throws BuildException
        Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a List type. Replacing all references in the process.
        Parameters:
        key - the key to match.
        file - the file to match.
        defaultValue - the default value to return if there is no match.
        Returns:
        List or defaultValue if no match is found.
        Throws:
        BuildException - if the typecast fails
        • getListFileVariable

          default java.util.List<java.lang.Object> getListFileVariable​(java.lang.String key,
                                                                       java.lang.String file)
                                                                throws BuildException
          Retrieves the first match for the specified key and file or null if there is no match and casts it to a List type. Replacing all references in the process.
          Parameters:
          key - the key to match.
          file - the file to match.
          Returns:
          List or null if no match is found.
          Throws:
          BuildException - if the typecast fails
          • getListStringFileVariable

            default java.util.List<java.lang.String> getListStringFileVariable​(java.lang.String key,
                                                                               java.lang.String file,
                                                                               java.util.List<java.lang.String> defaultValue)
                                                                        throws BuildException
            Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a List type. Replacing all references in the process.
            Parameters:
            key - the key to match.
            file - the file to match.
            defaultValue - the default value to return if there is no match.
            Returns:
            List or defaultValue if no match is found.
            Throws:
            BuildException - if the typecast fails
          • getListStringFileVariable

            default java.util.List<java.lang.String> getListStringFileVariable​(java.lang.String key,
                                                                               java.lang.String file)
                                                                        throws BuildException
            Retrieves the first match for the specified key and file or null if there is no match and casts it to a List type. Replacing all references in the process.
            Parameters:
            key - the key to match.
            file - the file to match.
            Returns:
            List or null if no match is found.
            Throws:
            BuildException - if the typecast fails
          • getSetFileVariable

            default java.util.Set<java.lang.Object> getSetFileVariable​(java.lang.String key,
                                                                       java.lang.String file)
                                                                throws BuildException
            Retrieves the first match for the specified key and file or null if there is no match and casts it to a Set type. Replacing all references in the process.
            Parameters:
            key - the key to match.
            file - the file to match.
            Returns:
            Set or null if no match is found.
            Throws:
            BuildException - if the typecast fails
            • getSetFileVariable

              default java.util.Set<java.lang.Object> getSetFileVariable​(java.lang.String key,
                                                                         java.lang.String file,
                                                                         java.util.Set<java.lang.Object> defaultValue)
                                                                  throws BuildException
              Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a Set type. Replacing all references in the process.
              Parameters:
              key - the key to match.
              file - the file to match.
              defaultValue - the default value to return if there is no match.
              Returns:
              Set or defaultValue if no match is found.
              Throws:
              BuildException - if the typecast fails
              • getSetStringFileVariable

                default java.util.Set<java.lang.String> getSetStringFileVariable​(java.lang.String key,
                                                                                 java.lang.String file)
                                                                          throws BuildException
                Retrieves the first match for the specified key and file or null if there is no match and casts it to a Set type. Replacing all references in the process.
                Parameters:
                key - the key to match.
                file - the file to match.
                Returns:
                Set or null if no match is found.
                Throws:
                BuildException - if the typecast fails
              • getSetStringFileVariable

                default java.util.Set<java.lang.String> getSetStringFileVariable​(java.lang.String key,
                                                                                 java.lang.String file,
                                                                                 java.util.Set<java.lang.String> defaultValue)
                                                                          throws BuildException
                Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a Set type. Replacing all references in the process.
                Parameters:
                key - the key to match.
                file - the file to match.
                defaultValue - the default value to return if there is no match.
                Returns:
                Set or defaultValue if no match is found.
                Throws:
                BuildException - if the typecast fails
              • getMapFileVariable

                default java.util.Map<java.lang.String,​java.lang.Object> getMapFileVariable​(java.lang.String key,
                                                                                                  java.lang.String file,
                                                                                                  java.util.Map<java.lang.String,​java.lang.Object> defaultValue)
                                                                                           throws BuildException
                Retrieves the first match for the specified key and file or the default value if there is no match and casts it to a Map type. Replacing all references in the process.
                Parameters:
                key - the key to match.
                file - the file to match.
                defaultValue - the default value to return if there is no match.
                Returns:
                Map or defaultValue if no match is found.
                Throws:
                BuildException - if the typecast fails
              • getMapFileVariable

                default java.util.Map<java.lang.String,​java.lang.Object> getMapFileVariable​(java.lang.String key,
                                                                                                  java.lang.String file)
                                                                                           throws BuildException
                Retrieves the first match for the specified key and file or null if there is no match and casts it to a Map type. Replacing all references in the process.
                Parameters:
                key - the key to match.
                file - the file to match.
                Returns:
                Map or null if no match is found.
                Throws:
                BuildException - if the typecast fails