Interface TokenConfiguration

  • All Known Subinterfaces:
    IacBackendSpec

    public interface TokenConfiguration
    Configures backend tokens
    Since:
    2.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addTokenProvider​(org.gradle.api.provider.Provider<java.util.Map<java.lang.String,​TokenValue>> tokenProvider)
      Adds a provider of tokens.
      void fileToken​(java.lang.String key, java.lang.Object value)
      Set a single token value.
      void setTokens​(java.util.Map<java.lang.String,​?> newTokens)
      Replace all tokens with a new set.
      void token​(java.lang.String key, java.lang.Object value)
      Set a single token value.
      void tokens​(java.util.Map<java.lang.String,​?> moreTokens)
      Adds more tokens.
    • Method Detail

      • setTokens

        void setTokens​(java.util.Map<java.lang.String,​?> newTokens)
        Replace all tokens with a new set.

        Only useful when a custom template is used.

        Parameters:
        newTokens - New replacement set
      • tokens

        void tokens​(java.util.Map<java.lang.String,​?> moreTokens)
        Adds more tokens.

        Only useful when a custom template is used.

        Parameters:
        moreTokens - Additional tokens for replacement.
      • token

        void token​(java.lang.String key,
                   java.lang.Object value)
        Set a single token value.
        Parameters:
        key - Token name
        value - Lazy-evaluted value. Anything that can resolve to a string.
      • fileToken

        void fileToken​(java.lang.String key,
                       java.lang.Object value)
        Set a single token value.
        Parameters:
        key - Token name
        value - Lazy-evaluted value which is known to be a file. Anything that can resolve to a file.
      • addTokenProvider

        void addTokenProvider​(org.gradle.api.provider.Provider<java.util.Map<java.lang.String,​TokenValue>> tokenProvider)
        Adds a provider of tokens.

        These providers are processed before any of the customisations on the class.

        Parameters:
        tokenProvider - Addition provider of tokens
        Since:
        1.0