XmlEscapingStrategy (CONGA Generator 1.17.1-SNAPSHOT API)

java.lang.Object
- io.wcm.devops.conga.generator.plugins.handlebars.escaping.XmlEscapingStrategy

All Implemented Interfaces:: EscapingStrategyPlugin, Plugin

public class XmlEscapingStrategy
extends Object
implements EscapingStrategyPlugin

Escapes for XML files.

Field Summary

Fields
Modifier and Type Field Description

static String NAME
Plugin name

Constructor Summary

Constructors
Constructor Description

XmlEscapingStrategy()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`accepts(String fileExtension, EscapingStrategyContext pluginContext)`	Checks if the plugin can be applied to files with the given file extension.
`String`	`escape(CharSequence value, EscapingStrategyContext pluginContext)`	Escape the `CharSequence`.
`String`	`getName()`

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

- Field Detail
  - NAME
```
public static final String NAME
```
    Plugin name
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XmlEscapingStrategy
```
public XmlEscapingStrategy()
```
- Method Detail
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface Plugin
    
    Returns:
    
    Plugin name to be referenced in definition file
  - accepts
```
public boolean accepts(String fileExtension,
                       EscapingStrategyContext pluginContext)
```
    Description copied from interface: EscapingStrategyPlugin
    
    Checks if the plugin can be applied to files with the given file extension.
    
    Specified by:
    
    accepts in interface EscapingStrategyPlugin
    
    Parameters:
    
    fileExtension - File extension
    
    pluginContext - Plugin context
    
    Returns:
    
    true when the plugin can be applied to the given file.
  - escape
```
public String escape(CharSequence value,
                     EscapingStrategyContext pluginContext)
```
    Description copied from interface: EscapingStrategyPlugin
    
    Escape the CharSequence.
    
    Specified by:
    
    escape in interface EscapingStrategyPlugin
    
    Parameters:
    
    value - the character sequence to be escaped.
    
    pluginContext - Plugin context
    
    Returns:
    
    the escaped character sequence.