ExpandableParameter (OpenNMS 2022.1.1 API)

java.lang.Object
- org.opennms.netmgt.eventd.processor.expandable.ExpandableParameter

All Implemented Interfaces:

ExpandableToken
```
public class ExpandableParameter
extends Object
implements ExpandableToken
```
An ExpandableParameter requires the {@link #ExpandableParameter#parameter} to be replaced with an appropriate value. Each token may be mapped to a ExpandableParameterResolver resolving the token to a value. If no resolver is found, null is returned.

See Also:

ExpandableParameterResolverRegistry

Constructor Summary

Constructors
Constructor Description

ExpandableParameter(String token, EventUtil eventUtil)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`expand(Event event, Map<String,Map<String,String>> decode)`	Expands a token.
`boolean`	`requiresTransaction()`	Defines if this `ExpandableToken` requires a transaction to be expanded.

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

- Constructor Detail
  - ExpandableParameter
```
public ExpandableParameter(String token,
                           EventUtil eventUtil)
```
- Method Detail
  - expand
```
public String expand(Event event,
                     Map<String,Map<String,String>> decode)
```
    Description copied from interface: ExpandableToken
    
    Expands a token.
    
    Specified by:
    
    expand in interface ExpandableToken
    
    Parameters:
    
    event - An event, to expand the token from. May not be null.
    
    decode - A Map, to help expanding the token. May be null.
    
    Returns:
    
    The expanded token.
  - requiresTransaction
```
public boolean requiresTransaction()
```
    Description copied from interface: ExpandableToken
    
    Defines if this ExpandableToken requires a transaction to be expanded.
    
    Specified by:
    
    requiresTransaction in interface ExpandableToken
    
    Returns:
    
    True if a transaction is required, False otherwise.