Package com.funnelback.plugin.details.model

Class PluginConfigFile.PluginConfigFileBuilder

java.lang.Object

com.funnelback.plugin.details.model.PluginConfigFile.PluginConfigFileBuilder

Enclosing class:

PluginConfigFile

public static class PluginConfigFile.PluginConfigFileBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private String	description
private String	format
private String	label
private String	name
private boolean	required

Constructor Summary

Constructors

Constructor	Description
PluginConfigFileBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

name

private String name

label

private String label

description

private String description

format

private String format

required

private boolean required

Constructor Detail

PluginConfigFileBuilder

PluginConfigFileBuilder()

Method Detail

name

public PluginConfigFile.PluginConfigFileBuilder name(@NonNull
                                                     @NonNull String name)

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

Returns:

this.

label

public PluginConfigFile.PluginConfigFileBuilder label(@NonNull
                                                      @NonNull String label)

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

Returns:

this.

description

public PluginConfigFile.PluginConfigFileBuilder description(@NonNull
                                                            @NonNull String description)

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

Returns:

this.

format

public PluginConfigFile.PluginConfigFileBuilder format(@NonNull
                                                       @NonNull String format)

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

Returns:

this.

required

public PluginConfigFile.PluginConfigFileBuilder required(boolean required)

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

Returns:

this.

build

public PluginConfigFile build()

toString

public String toString()

Overrides:

toString in class Object