Package org.apache.nifi.parameter

Class ParameterGroupConfiguration

java.lang.Object

org.apache.nifi.parameter.ParameterGroupConfiguration

All Implemented Interfaces:

Comparable<ParameterGroupConfiguration>

public class ParameterGroupConfiguration
extends Object
implements Comparable<ParameterGroupConfiguration>

User-provided configuration for a group of parameters fetched from a ParameterProvider.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	groupName
private final Boolean	isSynchronized
private final String	parameterContextName
private final Map<String,ParameterSensitivity>	parameterSensitivities

Constructor Summary

Constructors

Constructor	Description
ParameterGroupConfiguration(String groupName, String parameterContextName, Map<String,ParameterSensitivity> parameterSensitivities, Boolean isSynchronized)	Creates a named group of parameter names.

Method Summary

Modifier and Type	Method	Description
int	compareTo(ParameterGroupConfiguration other)
String	getGroupName()
String	getParameterContextName()
Map<String,ParameterSensitivity>	getParameterSensitivities()
Boolean	isSynchronized()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

groupName

private final String groupName

parameterContextName

private final String parameterContextName

parameterSensitivities

private final Map<String,ParameterSensitivity> parameterSensitivities

isSynchronized

private final Boolean isSynchronized

Constructor Details

ParameterGroupConfiguration

public ParameterGroupConfiguration(String groupName,
 String parameterContextName,
 Map<String,ParameterSensitivity> parameterSensitivities,
 Boolean isSynchronized)

Creates a named group of parameter names.

Parameters:

groupName - The parameter group name

parameterContextName - The parameter context name to which parameters will be applied

parameterSensitivities - A map from parameter name to desired sensitivity. Any parameter not included in this map will not be included when applied to the parameter context.

isSynchronized - If true, indicates that a ParameterContext should be created if not already existing, or updated if existing

Method Details

getGroupName

public String getGroupName()

Returns:

The external parameter group name

getParameterContextName

public String getParameterContextName()

Returns:

The name of the ParameterContext that maps to this group

getParameterSensitivities

public Map<String,ParameterSensitivity> getParameterSensitivities()

Returns:

A map from parameter name to desired sensitivity. If the sensitivity is null, this indicates that the parameter has not yet been configured by the user.

isSynchronized

public Boolean isSynchronized()

Returns:

True if this group should be synchronized with a parameter context. If null, this indicates that it has not yet been configured by the user.

compareTo

public int compareTo(ParameterGroupConfiguration other)

Specified by:

compareTo in interface Comparable<ParameterGroupConfiguration>