Package com.funnelback.plugin.details.model

Class PluginConfigKeyConditional<T>

java.lang.Object

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

Type Parameters:

T - type of key values

public class PluginConfigKeyConditional<T>
extends Object

Define plugin configuration keys' dependency on each other to display it in plugin configuration admin UI and in auto-generated documentation. If the usage of key B depends on a specific value set for key A, this can define by setting on a definition of key B `PluginConfigKeyConditional`, for example: Key B will be used only if key A has a value set to "X" or "Z

 new PluginConfigKeyConditional<String>("plugin.keyA.config.example", List.of("X", "Z"))
 

or using a builder

 PluginConfigKeyConditional.<String>builder()
      .associatedKeyId("plugin.keyA.config.example")
      .associatedKeyValue("X")
      .associatedKeyValue("Z")
      .build()
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PluginConfigKeyConditional.PluginConfigKeyConditionalBuilder<T>

Field Summary

Fields

Modifier and Type	Field	Description
private @NonNull String	associatedKeyId	Plugin configuration key
private @NonNull List<T>	associatedKeyValues	List of values

Constructor Summary

Constructors

Constructor	Description
PluginConfigKeyConditional(@NonNull String associatedKeyId, @NonNull List<T> associatedKeyValues)

Method Summary

Modifier and Type	Method	Description
static <T> PluginConfigKeyConditional.PluginConfigKeyConditionalBuilder<T>	builder()
@NonNull String	getAssociatedKeyId()	Plugin configuration key
@NonNull List<T>	getAssociatedKeyValues()	List of values

Methods inherited from class java.lang.Object

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

Field Detail

associatedKeyId

@NonNull
private final @NonNull String associatedKeyId

Plugin configuration key

associatedKeyValues

@NonNull
private final @NonNull List<T> associatedKeyValues

List of values

Constructor Detail

PluginConfigKeyConditional

public PluginConfigKeyConditional(@NonNull
                                  @NonNull String associatedKeyId,
                                  @NonNull
                                  @NonNull List<T> associatedKeyValues)

Method Detail

builder

public static <T> PluginConfigKeyConditional.PluginConfigKeyConditionalBuilder<T> builder()

getAssociatedKeyId

@NonNull
public @NonNull String getAssociatedKeyId()

Plugin configuration key

getAssociatedKeyValues

@NonNull
public @NonNull List<T> getAssociatedKeyValues()

List of values