Class ToolParameters.ToolParametersBuilder

java.lang.Object

me.neurodock.plugin.tool.ToolParameters.ToolParametersBuilder

Enclosing class:

ToolParameters

public static class ToolParameters.ToolParametersBuilder
extends Object

Represents a builder for ToolParameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ToolParameters.ToolParametersBuilder.Type	Represents the type of parameter.

Constructor Summary

Constructors

Constructor	Description
ToolParametersBuilder()

Method Summary

Modifier and Type	Method	Description
ToolParameters.ToolParametersBuilder	addProperty(String name, ToolParameters.ToolParametersBuilder.Type type, String description)	Add an optinal perameter to this ToolParameters.ToolParametersBuilder
ToolParameters.ToolParametersBuilder	addProperty(String name, ToolParameters.ToolParametersBuilder.Type type, String description, boolean required)	Add a potentialy required peremeter to this ToolParameters.ToolParametersBuilder.
ToolParameters	build()	Builds the ToolParameters
ToolParameters.ToolParametersBuilder	removeProperty(String name)	Removes a property from the parameters.
ToolParameters.ToolParametersBuilder	required(String name)	Makes a previusly optinal perameter required for this ToolParameters.ToolParametersBuilder

Methods inherited from class Object

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

Constructor Details

ToolParametersBuilder

public ToolParametersBuilder()

Method Details

addProperty

public ToolParameters.ToolParametersBuilder addProperty(String name,
 ToolParameters.ToolParametersBuilder.Type type,
 String description)

Add an optinal perameter to this ToolParameters.ToolParametersBuilder

Parameters:

name - The name of the parameter

type - The type of the parameter

description - The description of the parameter

Returns:

The ToolParameters.ToolParametersBuilder

addProperty

public ToolParameters.ToolParametersBuilder addProperty(String name,
 ToolParameters.ToolParametersBuilder.Type type,
 String description,
 boolean required)

Add a potentialy required peremeter to this ToolParameters.ToolParametersBuilder.

Parameters:

name - The name of the parameter

type - The type of the parameter

description - The description of the parameter

required - The required state of the parameter

Returns:

The ToolParameters.ToolParametersBuilder

required

public ToolParameters.ToolParametersBuilder required(String name)

Makes a previusly optinal perameter required for this ToolParameters.ToolParametersBuilder

Parameters:

name - The name of the parameter

Returns:

The ToolParameters.ToolParametersBuilder

removeProperty

public ToolParameters.ToolParametersBuilder removeProperty(String name)

Removes a property from the parameters.

Parameters:

name - The name of the property to remove

Returns:

The ToolParameters.ToolParametersBuilder

build

public ToolParameters build()

Builds the ToolParameters

Returns:

The ToolParameters