Package com.funnelback.plugin.details.model

Class PluginConfigKey<T>

java.lang.Object

com.funnelback.plugin.details.model.PluginConfigKeyBase

com.funnelback.plugin.details.model.PluginConfigKey<T>

Type Parameters:

T - type of key value

All Implemented Interfaces:

PluginConfigKeyDetails, PluginDetailsBase

public class PluginConfigKey<T>
extends PluginConfigKeyBase

Defines plugin configuration key properties For example, to define configuration key 'plugin.pluginID.config.foo.*'

 new PluginConfigKey <String>(getPluginId(), "foo.*", "Key label", "Key desc", true, new PluginConfigKeyType(PluginConfigKeyType.Format.STRING), null, null, null)
 

or using builder

 PluginConfigKey.<String>builder()
      .pluginId(getPluginId())
      .id("foo.*")
      .label("Key label")
      .description("Key desc")
      .longDescription("Longer more explanatory description of key")
      .required(true)
      .type(new PluginConfigKeyType(PluginConfigKeyType.Format.STRING))
 

- to define default value provide value in expected format getDefaultValue() - to restrict allowed values getAllowedValue() - to set dependency of keys on each other getShowIfKeyHasValue()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PluginConfigKey.PluginConfigKeyBuilder<T>

Field Summary

Fields

Modifier and Type	Field	Description
private PluginConfigKeyAllowedValue<T>	allowedValue	Defines range of allowed plugin configuration key values, for details see PluginConfigKeyAllowedValue
private T	defaultValue	Defines the default value of plugin configuration key
private PluginConfigKeyConditional	showIfKeyHasValue	Defines conditional usage of plugin configuration key based on other key's value, for details see PluginConfigKeyConditional

Fields inherited from class com.funnelback.plugin.details.model.PluginConfigKeyBase

id

Fields inherited from interface com.funnelback.plugin.details.model.PluginDetailsBase

PLUGIN_CONFIG_QUALIFIER, PLUGIN_ENCRYPTED_QUALIFIER, PLUGIN_PREFIX

Constructor Summary

Constructors

Constructor	Description
PluginConfigKey(@NonNull String pluginId, @NonNull String id, @NonNull String label, @NonNull String description, boolean required, @NonNull PluginConfigKeyType type, T defaultValue, PluginConfigKeyAllowedValue<T> allowedValue, PluginConfigKeyConditional showIfKeyHasValue)
PluginConfigKey(@NonNull String pluginId, @NonNull String id, @NonNull String label, @NonNull String description, String longDescription, boolean required, @NonNull PluginConfigKeyType type, T defaultValue, PluginConfigKeyAllowedValue<T> allowedValue, PluginConfigKeyConditional showIfKeyHasValue)

Method Summary

Modifier and Type	Method	Description
static <T> PluginConfigKey.PluginConfigKeyBuilder<T>	builder()
PluginConfigKeyAllowedValue<T>	getAllowedValue()	Defines range of allowed plugin configuration key values, for details see PluginConfigKeyAllowedValue
T	getDefaultValue()	Defines the default value of plugin configuration key
PluginConfigKeyConditional	getShowIfKeyHasValue()	Defines conditional usage of plugin configuration key based on other key's value, for details see PluginConfigKeyConditional

Methods inherited from class com.funnelback.plugin.details.model.PluginConfigKeyBase

getDescription, getKey, getKey, getLabel, getLongDescription, getPluginId, getType, isRequired

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.funnelback.plugin.details.model.PluginDetailsBase

getKeyPrefix

Field Detail

defaultValue

private final T defaultValue

Defines the default value of plugin configuration key

allowedValue

private final PluginConfigKeyAllowedValue<T> allowedValue

Defines range of allowed plugin configuration key values, for details see PluginConfigKeyAllowedValue

showIfKeyHasValue

private final PluginConfigKeyConditional showIfKeyHasValue

Defines conditional usage of plugin configuration key based on other key's value, for details see PluginConfigKeyConditional

Constructor Detail

PluginConfigKey

public PluginConfigKey(@NonNull
                       @NonNull String pluginId,
                       @NonNull
                       @NonNull String id,
                       @NonNull
                       @NonNull String label,
                       @NonNull
                       @NonNull String description,
                       boolean required,
                       @NonNull
                       @NonNull PluginConfigKeyType type,
                       T defaultValue,
                       PluginConfigKeyAllowedValue<T> allowedValue,
                       PluginConfigKeyConditional showIfKeyHasValue)

PluginConfigKey

public PluginConfigKey(@NonNull
                       @NonNull String pluginId,
                       @NonNull
                       @NonNull String id,
                       @NonNull
                       @NonNull String label,
                       @NonNull
                       @NonNull String description,
                       String longDescription,
                       boolean required,
                       @NonNull
                       @NonNull PluginConfigKeyType type,
                       T defaultValue,
                       PluginConfigKeyAllowedValue<T> allowedValue,
                       PluginConfigKeyConditional showIfKeyHasValue)

Method Detail

builder

public static <T> PluginConfigKey.PluginConfigKeyBuilder<T> builder()

getDefaultValue

public T getDefaultValue()

Defines the default value of plugin configuration key

getAllowedValue

public PluginConfigKeyAllowedValue<T> getAllowedValue()

Defines range of allowed plugin configuration key values, for details see PluginConfigKeyAllowedValue

getShowIfKeyHasValue

public PluginConfigKeyConditional getShowIfKeyHasValue()

Defines conditional usage of plugin configuration key based on other key's value, for details see PluginConfigKeyConditional