AbstractBackendSpec (Jobble Gradle Plugin Suite Combined API 0.14.1)

org.ysb33r.gradle.terraform.remotestate.AbstractBackendSpec

All Implemented Interfaces and Traits:

BackendSpec
```
@groovy.transform.CompileStatic
@java.lang.SuppressWarnings('AbstractClassWithoutAbstractMethod')
abstract class AbstractBackendSpec
```
Base class for simplify implementation of backend specifications.
Authors:
Schalk W. Cronjé
Since:
0.12

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`DEFAULT_TOKEN_DELIMITER`

Properties Summary

Properties
Type	Name and description
`Provider<java.io.File>`	`templateFile`
`Provider<BackendTextTemplate>`	`textTemplate`
`java.util.Map<java.lang.String, java.lang.Object>`	`tokens`

Constructor Summary

Constructors
Constructor and description
`protected AbstractBackendSpec (ProjectOperations po, ObjectFactory objects)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addTokenProvider(Provider<java.util.Map<java.lang.String, java.lang.Object>> tokenProvider)` Adds a provider of tokens.
	`void`	`allTokenTemplate()` The template is simply a dump of all tokens that were set.
	`void`	`clear()` Reset all tokens as well as token delimiters.
	`void`	`configure(Action<? extends BackendSpec> configurator)` Configures the backend according to a specification
	`void`	`configure(groovy.lang.Closure configurator)` Configures the backend according to a specification
	`void`	`delimiterTokenPair(java.lang.String begin, java.lang.String end)` Sets new delimiters for tokens.
`<T extends BackendSpec>`	`static T`	`findExtension(Project project, java.lang.Class<T> clazz)` Utility method to find a backend extension on a project.
`<T extends BackendSpec>`	`static T`	`findExtension(Project project, java.lang.String sourceSetName, java.lang.Class<T> clazz)` Utility to find a backend extension on a terraform source set.
	`Provider<java.lang.String>`	`getBeginTokenProvider()` Starting delimiter for tokens.
	`Provider<java.lang.String>`	`getEndTokenProvider()` Terminating delimiter for tokens
	`protected ProjectOperations`	`getProjectOperations()`
	`Provider<java.io.File>`	`getTemplateFile()` Returns location of template file.
	`Provider<BackendTextTemplate>`	`getTextTemplate()` Returns text template.
	`Provider<java.util.Map<java.lang.String, ?>>`	`getTokenProvider()` A provider for all the tokens that were set.
	`java.util.Map<java.lang.String, java.lang.Object>`	`getTokens()` Returns the current set of tokens
	`void`	`setTemplateFile(java.lang.Object file)` Applies a custom template file for backend configuration.
	`void`	`setTextTemplate(java.lang.Object text)` Use a string as a template.
	`void`	`setTokens(java.util.Map<java.lang.String, java.lang.Object> newTokens)` Replace all tokens with a new set.
	`void`	`token(java.lang.String key, java.lang.Object value)` Set a single token value.
	`protected void`	`tokenPath(java.lang.String key, java.lang.Object p)` Adds a token value that will be evaluated to a file path.
	`void`	`tokens(java.util.Map<java.lang.String, java.lang.Object> moreTokens)` Adds more tokens.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final java.lang.String DEFAULT_TOKEN_DELIMITER
- Property Detail
  - Provider<java.io.File> templateFile
  - Provider<BackendTextTemplate> textTemplate
  - java.util.Map<java.lang.String, java.lang.Object> tokens
- Constructor Detail
  - protected AbstractBackendSpec(ProjectOperations po, ObjectFactory objects)
- Method Detail
  - @java.lang.Override void addTokenProvider(Provider<java.util.Map<java.lang.String, java.lang.Object>> 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
  - @java.lang.Override void allTokenTemplate()
    
    The template is simply a dump of all tokens that were set.
  - void clear()
    
    Reset all tokens as well as token delimiters.
  - @java.lang.Override void configure(Action<? extends BackendSpec> configurator)
    
    Configures the backend according to a specification
    Parameters:
    configurator - Configurating action
  - @java.lang.Override void configure(groovy.lang.Closure configurator)
    
    Configures the backend according to a specification
    Parameters:
    configurator - Configurating closure
  - @java.lang.Override void delimiterTokenPair(java.lang.String begin, java.lang.String end)
    
    Sets new delimiters for tokens.
    Only useful when a custom template is used.
    Parameters:
    begin - Start delimiter for tokens
    end - End delimiter for tokens
  - <T extends BackendSpec> static T findExtension(Project project, java.lang.Class<T> clazz)
    
    Utility method to find a backend extension on a project.
    Parameters:
    project - Project context.
    clazz - The type of the extension.
    Returns:
    Extension after it has been attached.
    Since:
    0.12
  - <T extends BackendSpec> static T findExtension(Project project, java.lang.String sourceSetName, java.lang.Class<T> clazz)
    
    Utility to find a backend extension on a terraform source set.
    Parameters:
    project - Project context
    sourceSetName - Name of source set.
    clazz - The type of the extension.
    Returns:
    Extension after it has been attached.
    Since:
    0.12
  - @java.lang.Override Provider<java.lang.String> getBeginTokenProvider()
    
    Starting delimiter for tokens.
    Only useful when a custom template is used.
    Returns:
    Provider for start delimiter
    Since:
    0.12
  - @java.lang.Override Provider<java.lang.String> getEndTokenProvider()
    
    Terminating delimiter for tokens
    Only useful when a custom template is used.
    Returns:
    Provider for end delimiter
    Since:
    0.12
  - protected ProjectOperations getProjectOperations()
  - @java.lang.Override Provider<java.io.File> getTemplateFile()
    
    Returns location of template file.
    Returns:
    Location of template file if set.
  - @java.lang.Override Provider<BackendTextTemplate> getTextTemplate()
    
    Returns text template.
    Returns:
    text of template if set.
  - Provider<java.util.Map<java.lang.String, ?>> getTokenProvider()
    
    A provider for all the tokens that were set.
    Returns:
    Provider to a map of tokens.
  - @java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getTokens()
    
    Returns the current set of tokens
    Returns:
    Tokens used for replacements.
  - @java.lang.Override void setTemplateFile(java.lang.Object file)
    
    Applies a custom template file for backend configuration.
    Parameters:
    file - Location of template file
  - @java.lang.Override void setTextTemplate(java.lang.Object text)
    
    Use a string as a template.
    Parameters:
    text - Template that can be processed by Ant's ReplaceTokens.
  - @java.lang.Override void setTokens(java.util.Map<java.lang.String, java.lang.Object> newTokens)
    
    Replace all tokens with a new set.
    Only useful when a custom template is used.
    Parameters:
    newTokens - New replacement set
  - @java.lang.Override 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.
  - protected void tokenPath(java.lang.String key, java.lang.Object p)
    
    Adds a token value that will be evaluated to a file path.
    Parameters:
    key - Token name
    p - Object to be evaluated as a file path.
  - @java.lang.Override void tokens(java.util.Map<java.lang.String, java.lang.Object> moreTokens)
    
    Adds more tokens.
    Only useful when a custom template is used.
    Parameters:
    moreTokens - Additional tokens for replacement.

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractBackendSpec

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String DEFAULT_TOKEN_DELIMITER

Property Detail

Provider<java.io.File> templateFile

Provider<BackendTextTemplate> textTemplate

java.util.Map<java.lang.String, java.lang.Object> tokens

Constructor Detail

protected AbstractBackendSpec(ProjectOperations po, ObjectFactory objects)

Method Detail

@java.lang.Override void addTokenProvider(Provider<java.util.Map<java.lang.String, java.lang.Object>> tokenProvider)

@java.lang.Override void allTokenTemplate()

void clear()

@java.lang.Override void configure(Action<? extends BackendSpec> configurator)

@java.lang.Override void configure(groovy.lang.Closure configurator)

@java.lang.Override void delimiterTokenPair(java.lang.String begin, java.lang.String end)

<T extends BackendSpec> static T findExtension(Project project, java.lang.Class<T> clazz)

<T extends BackendSpec> static T findExtension(Project project, java.lang.String sourceSetName, java.lang.Class<T> clazz)

@java.lang.Override Provider<java.lang.String> getBeginTokenProvider()

@java.lang.Override Provider<java.lang.String> getEndTokenProvider()

protected ProjectOperations getProjectOperations()

@java.lang.Override Provider<java.io.File> getTemplateFile()

@java.lang.Override Provider<BackendTextTemplate> getTextTemplate()

Provider<java.util.Map<java.lang.String, ?>> getTokenProvider()

@java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getTokens()

@java.lang.Override void setTemplateFile(java.lang.Object file)

@java.lang.Override void setTextTemplate(java.lang.Object text)

@java.lang.Override void setTokens(java.util.Map<java.lang.String, java.lang.Object> newTokens)

@java.lang.Override void token(java.lang.String key, java.lang.Object value)

protected void tokenPath(java.lang.String key, java.lang.Object p)

@java.lang.Override void tokens(java.util.Map<java.lang.String, java.lang.Object> moreTokens)