Package com.funnelback.plugin.details.model

Class PluginConfigFile

java.lang.Object

com.funnelback.plugin.details.model.PluginConfigFile

public class PluginConfigFile
extends Object

Defines plugin configuration file properties For example, to define JSON file

 new PluginConfigFile("rules.json", "Plugin rules", "Define a list of rules to extract data", "json", true)
 

or using a builder

 PluginConfigFile.builder()
      .name("rules.json")
      .label("Plugin rules")
      .description("Define a list of rules to extract data")
      .format("json")
      .required(true)
      .build()
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PluginConfigFile.PluginConfigFileBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private @NonNull String	description	Description of plugin configuration file to display in plugin configuration admin UI and in auto-generated documentation
private @NonNull String	format	Expected format of plugin configuration file For example: json, xml, txt
private @NonNull String	label	Label for plugin configuration file to display in plugin configuration admin UI
private @NonNull String	name	Plugin configuration file name For example: rules.json, properties.cfg
private boolean	required	Mark plugin configuration file as required or optional in plugin configuration admin UI and in auto-generated documentation

Constructor Summary

Constructors

Constructor	Description
PluginConfigFile(@NonNull String name, @NonNull String label, @NonNull String description, @NonNull String format, boolean required)

Method Summary

Modifier and Type	Method	Description
static PluginConfigFile.PluginConfigFileBuilder	builder()
@NonNull String	getDescription()	Description of plugin configuration file to display in plugin configuration admin UI and in auto-generated documentation
@NonNull String	getFormat()	Expected format of plugin configuration file For example: json, xml, txt
@NonNull String	getLabel()	Label for plugin configuration file to display in plugin configuration admin UI
@NonNull String	getName()	Plugin configuration file name For example: rules.json, properties.cfg
boolean	isRequired()	Mark plugin configuration file 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

Field Detail

name

@NonNull
private final @NonNull String name

Plugin configuration file name For example: rules.json, properties.cfg

label

@NonNull
private final @NonNull String label

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

description

@NonNull
private final @NonNull String description

Description of plugin configuration file to display in plugin configuration admin UI and in auto-generated documentation

format

@NonNull
private final @NonNull String format

Expected format of plugin configuration file For example: json, xml, txt

required

private final boolean required

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

Constructor Detail

PluginConfigFile

public PluginConfigFile(@NonNull
                        @NonNull String name,
                        @NonNull
                        @NonNull String label,
                        @NonNull
                        @NonNull String description,
                        @NonNull
                        @NonNull String format,
                        boolean required)

Method Detail

builder

public static PluginConfigFile.PluginConfigFileBuilder builder()

getName

@NonNull
public @NonNull String getName()

Plugin configuration file name For example: rules.json, properties.cfg

getLabel

@NonNull
public @NonNull String getLabel()

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

getDescription

@NonNull
public @NonNull String getDescription()

Description of plugin configuration file to display in plugin configuration admin UI and in auto-generated documentation

getFormat

@NonNull
public @NonNull String getFormat()

Expected format of plugin configuration file For example: json, xml, txt

isRequired

public boolean isRequired()

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