HandlebarsTemplateProcessor (Spring Cloud Contract Verifier 3.0.0 API)

java.lang.Object
- org.springframework.cloud.contract.verifier.template.HandlebarsTemplateProcessor

All Implemented Interfaces:

org.springframework.cloud.contract.spec.ContractTemplate, TemplateProcessor
```
public class HandlebarsTemplateProcessor
extends Object
implements TemplateProcessor, org.springframework.cloud.contract.spec.ContractTemplate
```
Default Handlebars template processor.

Since:

1.1.0

Author:

Marcin Grzejszczak

Constructor Summary

Constructors
Constructor and Description

HandlebarsTemplateProcessor()

Constructors
Constructor and Description
`HandlebarsTemplateProcessor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`body()`
`String`	`body(String jsonPath)`
`String`	`closingTemplate()`
`boolean`	`containsJsonPathTemplateEntry(String line)`
`boolean`	`containsTemplateEntry(String line)`
`String`	`cookie(String key)`
`String`	`escapedBody()`
`String`	`escapedBody(String jsonPath)`
`String`	`escapedClosingTemplate()`
`String`	`escapedCookie(String key)`
`String`	`escapedHeader(String key)`
`String`	`escapedHeader(String key, int index)`
`String`	`escapedOpeningTemplate()`
`String`	`escapedPath()`
`String`	`escapedPath(int index)`
`String`	`escapedQuery(String key)`
`String`	`escapedQuery(String key, int index)`
`String`	`escapedUrl()`
`String`	`header(String key)`
`String`	`header(String key, int index)`
`String`	`jsonPathFromTemplateEntry(String line)`
`String`	`openingTemplate()`
`String`	`path()`
`String`	`path(int index)`
`String`	`query(String key)`
`String`	`query(String key, int index)`
`boolean`	`startsWithEscapedTemplate(String text)`
`boolean`	`startsWithTemplate(String text)`
`String`	`transform(org.springframework.cloud.contract.spec.internal.Request request, String testContents)` For the given `Request` and the test contents should perform a transformation and return the converted test.
`String`	`url()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HandlebarsTemplateProcessor
```
public HandlebarsTemplateProcessor()
```
- Method Detail
  - transform
```
public String transform(org.springframework.cloud.contract.spec.internal.Request request,
                        String testContents)
```
    Description copied from interface: TemplateProcessor
    
    For the given Request and the test contents should perform a transformation and return the converted test.
    
    Specified by:
    
    transform in interface TemplateProcessor
  - containsTemplateEntry
```
public boolean containsTemplateEntry(String line)
```
    Specified by:
    
    containsTemplateEntry in interface TemplateProcessor
    
    Returns:
    
    true if the current line contains template related entry. E.g. for Handlebars if a line contains {{{...}}} then it's considered to contain template related entry
  - containsJsonPathTemplateEntry
```
public boolean containsJsonPathTemplateEntry(String line)
```
    Specified by:
    
    containsJsonPathTemplateEntry in interface TemplateProcessor
    
    Returns:
    
    true if the current line contains template related entry for json path processing. E.g. for Handlebars if a line contains {{{jsonpath ...}}} or {{{jsonPath ...}}} then it's considered to contain template related entry for json path processing
  - jsonPathFromTemplateEntry
```
public String jsonPathFromTemplateEntry(String line)
```
    Specified by:
    
    jsonPathFromTemplateEntry in interface TemplateProcessor
    
    Returns:
    
    the json path entry from the current line that contains template related entry for json path processing. E.g. for Handlebars if a line contains {{{jsonpath this '$.a.b.c'}}} or {{{jsonPath request.body ...}}} then the te method would return $.a.b.c. Returns empty string if there's no matching json path entry
  - startsWithTemplate
```
public boolean startsWithTemplate(String text)
```
    Specified by:
    
    startsWithTemplate in interface org.springframework.cloud.contract.spec.ContractTemplate
  - startsWithEscapedTemplate
```
public boolean startsWithEscapedTemplate(String text)
```
    Specified by:
    
    startsWithEscapedTemplate in interface org.springframework.cloud.contract.spec.ContractTemplate
  - openingTemplate
```
public String openingTemplate()
```
    Specified by:
    
    openingTemplate in interface org.springframework.cloud.contract.spec.ContractTemplate
  - closingTemplate
```
public String closingTemplate()
```
    Specified by:
    
    closingTemplate in interface org.springframework.cloud.contract.spec.ContractTemplate
  - escapedOpeningTemplate
```
public String escapedOpeningTemplate()
```
    Specified by:
    
    escapedOpeningTemplate in interface org.springframework.cloud.contract.spec.ContractTemplate
  - escapedClosingTemplate
```
public String escapedClosingTemplate()
```
    Specified by:
    
    escapedClosingTemplate in interface org.springframework.cloud.contract.spec.ContractTemplate
  - url
```
public String url()
```
    Specified by:
    
    url in interface org.springframework.cloud.contract.spec.ContractTemplate
  - query
```
public String query(String key)
```
    Specified by:
    
    query in interface org.springframework.cloud.contract.spec.ContractTemplate
  - query
```
public String query(String key,
                    int index)
```
    Specified by:
    
    query in interface org.springframework.cloud.contract.spec.ContractTemplate
  - path
```
public String path()
```
    Specified by:
    
    path in interface org.springframework.cloud.contract.spec.ContractTemplate
  - path
```
public String path(int index)
```
    Specified by:
    
    path in interface org.springframework.cloud.contract.spec.ContractTemplate
  - header
```
public String header(String key)
```
    Specified by:
    
    header in interface org.springframework.cloud.contract.spec.ContractTemplate
  - header
```
public String header(String key,
                     int index)
```
    Specified by:
    
    header in interface org.springframework.cloud.contract.spec.ContractTemplate
  - cookie
```
public String cookie(String key)
```
    Specified by:
    
    cookie in interface org.springframework.cloud.contract.spec.ContractTemplate
  - body
```
public String body()
```
    Specified by:
    
    body in interface org.springframework.cloud.contract.spec.ContractTemplate
  - body
```
public String body(String jsonPath)
```
    Specified by:
    
    body in interface org.springframework.cloud.contract.spec.ContractTemplate
  - escapedUrl
```
public String escapedUrl()
```
    Specified by:
    
    escapedUrl in interface org.springframework.cloud.contract.spec.ContractTemplate
  - escapedQuery
```
public String escapedQuery(String key)
```
    Specified by:
    
    escapedQuery in interface org.springframework.cloud.contract.spec.ContractTemplate
  - escapedQuery
```
public String escapedQuery(String key,
                           int index)
```
    Specified by:
    
    escapedQuery in interface org.springframework.cloud.contract.spec.ContractTemplate
  - escapedPath
```
public String escapedPath()
```
    Specified by:
    
    escapedPath in interface org.springframework.cloud.contract.spec.ContractTemplate
  - escapedPath
```
public String escapedPath(int index)
```
    Specified by:
    
    escapedPath in interface org.springframework.cloud.contract.spec.ContractTemplate
  - escapedHeader
```
public String escapedHeader(String key)
```
    Specified by:
    
    escapedHeader in interface org.springframework.cloud.contract.spec.ContractTemplate
  - escapedHeader
```
public String escapedHeader(String key,
                            int index)
```
    Specified by:
    
    escapedHeader in interface org.springframework.cloud.contract.spec.ContractTemplate
  - escapedCookie
```
public String escapedCookie(String key)
```
    Specified by:
    
    escapedCookie in interface org.springframework.cloud.contract.spec.ContractTemplate
  - escapedBody
```
public String escapedBody()
```
    Specified by:
    
    escapedBody in interface org.springframework.cloud.contract.spec.ContractTemplate
  - escapedBody
```
public String escapedBody(String jsonPath)
```
    Specified by:
    
    escapedBody in interface org.springframework.cloud.contract.spec.ContractTemplate

Class HandlebarsTemplateProcessor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HandlebarsTemplateProcessor

Method Detail

transform

containsTemplateEntry

containsJsonPathTemplateEntry

jsonPathFromTemplateEntry

startsWithTemplate

startsWithEscapedTemplate

openingTemplate

closingTemplate

escapedOpeningTemplate

escapedClosingTemplate

url

query

query

path

path

header

header

cookie

body

body

escapedUrl

escapedQuery

escapedQuery

escapedPath

escapedPath

escapedHeader

escapedHeader

escapedCookie

escapedBody

escapedBody