PluginProvidedDecoratorModule (Atlassian Confluence 8.9.1 API)

public interface PluginProvidedDecoratorModule

Holds data about the decorator override.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getTemplate()`
`String`	`key()`
`boolean`	`matches(String path)`	Returns true if this decorator override should match the given path.

- Method Detail
  - matches
```
boolean matches(String path)
```
    Returns true if this decorator override should match the given path.
    
    Parameters:
    
    path - the path. This path should start with a slash, and end just before the query string if any. Usually, the path is the concatenation of HttpServletRequest.getServletPath() and HttpServletRequest.getPathInfo().
    
    Returns:
    
    true if this module will match the given path
  - getTemplate
```
String getTemplate()
```
    Returns:
    
    A path to the template. This should be on the classpath.
  - key
```
String key()
```
    Returns:
    
    A key that uniquely describes this module.