static class AntoraExtension.CopyFilter extends Object
Defines a copy filter.
| Type Params | Return Type | Name and description |
|---|---|---|
|
CopySpec |
addFilter(CopySpec spec)Adds a filter to the copy specification based upon the tokens and the the delimiters |
|
String |
getEndToken()The terminating delimiter. |
|
String |
getStartToken()The starting delimiter. |
|
java.util.Map<String, String> |
getTokens()Get the list of tokens to use for substitution. |
|
void |
tokens(java.util.Map<String, ?> tok)Add additional tokens. |
|
void |
tokens(Provider<java.util.Map<String, Object>> tokProvider)Adds providers to additional tokens. |
Adds a filter to the copy specification based upon the tokens and the the delimiters
spec - Target CopySpec. The terminating delimiter.
By default it is ## so that is can safely be used in a YAML file.
The starting delimiter.
By default it is ## so that is can safely be used in a YAML file.
Get the list of tokens to use for substitution.
Evaluates tokens first, then the token providers in order as added. This means that token providers will override key values provdes by tokens.
Add additional tokens.
If nothing is added, the only VERSION will be used for substitution during
copy.
tok - Adds more replacement tokens. Values will only be evaluated at the time of
calling getTokens.