Package com.funnelback.plugin.details.model

Class PluginConfigKeyBase

java.lang.Object

com.funnelback.plugin.details.model.PluginConfigKeyBase

All Implemented Interfaces:

PluginConfigKeyDetails, PluginDetailsBase

Direct Known Subclasses:

PluginConfigKey, PluginConfigKeyEncrypted

public abstract class PluginConfigKeyBase
extends Object
implements PluginConfigKeyDetails

Field Summary

Fields

Modifier and Type	Field	Description
private @NonNull String	description	Short description of plugin configuration key to display in plugin configuration admin UI and in auto-generated documentation
protected @NonNull String	id	ID of key to create plugin configuration key For example, to create - key `plugin.pluginID.config.foo` provide `id="foo"` - key `plugin.pluginID.config.foo.bar` provide `id="foo.bar"` - key with wildcard `plugin.pluginID.config.foo.*` provide `id="foo.*"` - key with wildcard `plugin.pluginID.config.foo.*.baz` provide `id="foo.*.baz"` - key with wildcard `plugin.pluginID.config.*.*.foo` provide `id="*.*.foo"`
private @NonNull String	label	Label for plugin configuration key to display in plugin configuration admin UI
private String	longDescription	Longer description of plugin configuration key to display in plugin auto-generated documentation
private @NonNull String	pluginId	ID of a current plugin
private boolean	required	Mark plugin configuration key as required or optional in plugin configuration admin UI and in auto-generated documentation
private @NonNull PluginConfigKeyType	type	Type of plugin configuration key, for details see PluginConfigKeyType

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

PLUGIN_CONFIG_QUALIFIER, PLUGIN_ENCRYPTED_QUALIFIER, PLUGIN_PREFIX

Constructor Summary

Constructors

Constructor	Description
PluginConfigKeyBase(@NonNull String pluginId, @NonNull String id, @NonNull String label, @NonNull String description, boolean required, @NonNull PluginConfigKeyType type)
PluginConfigKeyBase(@NonNull String pluginId, @NonNull String id, @NonNull String label, @NonNull String description, String longDescription, boolean required, @NonNull PluginConfigKeyType type)

Method Summary

Modifier and Type	Method	Description
@NonNull String	getDescription()	Short description of plugin configuration key to display in plugin configuration admin UI and in auto-generated documentation
String	getKey()	Create plugin key based on provided key ID If ID was defined with wildcard, this method will return key in wildcard form.
String	getKey(String... wildcard)	Create plugin key based on provided key ID with resolving wildcards to provided values For example: - for ID `foo.*`, `getKey("something")` -> `plugin.pluginID.config.foo.something` - for ID `*.*.foo`, `getKey("something", "more")` -> `plugin.pluginID.config.something.more.foo`
@NonNull String	getLabel()	Label for plugin configuration key to display in plugin configuration admin UI
String	getLongDescription()	Longer description of plugin configuration key to display in plugin auto-generated documentation
@NonNull String	getPluginId()	ID of a current plugin
@NonNull PluginConfigKeyType	getType()	Type of plugin configuration key, for details see PluginConfigKeyType
boolean	isRequired()	Mark plugin configuration key as required or optional in plugin configuration admin UI and in auto-generated documentation

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.PluginConfigKeyDetails

getAllowedValue, getDefaultValue, getShowIfKeyHasValue

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

getKeyPrefix

Field Detail

pluginId

@NonNull
private final @NonNull String pluginId

ID of a current plugin

id

@NonNull
protected final @NonNull String id

ID of key to create plugin configuration key For example, to create - key `plugin.pluginID.config.foo` provide `id="foo"` - key `plugin.pluginID.config.foo.bar` provide `id="foo.bar"` - key with wildcard `plugin.pluginID.config.foo.*` provide `id="foo.*"` - key with wildcard `plugin.pluginID.config.foo.*.baz` provide `id="foo.*.baz"` - key with wildcard `plugin.pluginID.config.*.*.foo` provide `id="*.*.foo"`

label

@NonNull
private final @NonNull String label

Label for plugin configuration key to display in plugin configuration admin UI

description

@NonNull
private final @NonNull String description

Short description of plugin configuration key to display in plugin configuration admin UI and in auto-generated documentation

longDescription

private String longDescription

Longer description of plugin configuration key to display in plugin auto-generated documentation

required

private final boolean required

Mark plugin configuration key as required or optional in plugin configuration admin UI and in auto-generated documentation

type

@NonNull
private final @NonNull PluginConfigKeyType type

Type of plugin configuration key, for details see PluginConfigKeyType

Constructor Detail

PluginConfigKeyBase

public PluginConfigKeyBase(@NonNull
                           @NonNull String pluginId,
                           @NonNull
                           @NonNull String id,
                           @NonNull
                           @NonNull String label,
                           @NonNull
                           @NonNull String description,
                           boolean required,
                           @NonNull
                           @NonNull PluginConfigKeyType type)

PluginConfigKeyBase

public PluginConfigKeyBase(@NonNull
                           @NonNull String pluginId,
                           @NonNull
                           @NonNull String id,
                           @NonNull
                           @NonNull String label,
                           @NonNull
                           @NonNull String description,
                           String longDescription,
                           boolean required,
                           @NonNull
                           @NonNull PluginConfigKeyType type)

Method Detail

getKey

public String getKey()

Create plugin key based on provided key ID If ID was defined with wildcard, this method will return key in wildcard form. To resolve wildcard to particular value see getKey(String...) For example: - for ID `foo`, `getKey()` -> `plugin.pluginID.config.foo`, - for ID `foo.bar`, `getKey()` -> `plugin.pluginID.config.foo.bar` - for ID `*.*.foo`, `getKey()` -> `plugin.pluginID.config.*.*.foo`

Returns:

plugin configuration key

getKey

public String getKey(String... wildcard)

Create plugin key based on provided key ID with resolving wildcards to provided values For example: - for ID `foo.*`, `getKey("something")` -> `plugin.pluginID.config.foo.something` - for ID `*.*.foo`, `getKey("something", "more")` -> `plugin.pluginID.config.something.more.foo`

Parameters:

wildcard - list of wildcard values to replace in key

Returns:

plugin configuration key with resolved wildcard value

getPluginId

@NonNull
public @NonNull String getPluginId()

ID of a current plugin

Specified by:

getPluginId in interface PluginDetailsBase

getLabel

@NonNull
public @NonNull String getLabel()

Label for plugin configuration key to display in plugin configuration admin UI

getDescription

@NonNull
public @NonNull String getDescription()

Short description of plugin configuration key to display in plugin configuration admin UI and in auto-generated documentation

getLongDescription

public String getLongDescription()

Longer description of plugin configuration key to display in plugin auto-generated documentation

isRequired

public boolean isRequired()

Mark plugin configuration key as required or optional in plugin configuration admin UI and in auto-generated documentation

getType

@NonNull
public @NonNull PluginConfigKeyType getType()

Type of plugin configuration key, for details see PluginConfigKeyType