public static interface Operator.Builder
Modifier and Type | Method and Description |
---|---|
Operator.Builder |
addParameter(java.lang.String name,
java.lang.String label,
java.lang.String description,
java.lang.String type,
java.lang.String role,
java.lang.Object defaultValue,
boolean required,
ValueConstraint valueConstraint)
Adds a parameter definition to the builder.
|
Operator.Builder |
addParameterGroup(java.lang.String name,
java.lang.String label,
java.lang.String description,
java.lang.String type,
java.util.List<java.lang.String> parameters,
java.lang.String parentGroup)
Adds a parameter group that directly references parameters directly to the builder.
|
Operator |
build()
Creates an operator from this builder.
|
ValueConstraint |
newEnumerationConstraint(java.util.List<java.lang.String> values)
Returns an enumeration constraint.
|
ValueConstraint |
newRangeConstraint(java.lang.Number lowerBound,
java.lang.Number upperBound)
Returns a numeric range constraint.
|
ValueConstraint.StructureBuilder |
newStructureConstraintBuilder()
Returns a builder that can be used create a structure constraint.
|
Operator.Builder |
setCategories(java.util.List<java.lang.String> categories)
Sets the categories.
|
Operator.Builder |
setDescription(java.lang.String description)
Sets the description.
|
Operator.Builder |
setLabel(java.lang.String label)
Sets the label.
|
Operator.Builder setLabel(java.lang.String label)
label
- the human-readable labelOperator.Builder setDescription(java.lang.String description)
description
- the human-readable descriptionOperator.Builder setCategories(java.util.List<java.lang.String> categories)
categories
- the categories this operator belongs toOperator.Builder addParameter(java.lang.String name, java.lang.String label, java.lang.String description, java.lang.String type, java.lang.String role, java.lang.Object defaultValue, boolean required, ValueConstraint valueConstraint)
name
- the parameter namelabel
- the parameter labeldescription
- the parameter description or null
type
- the parameter typerole
- the (optional) role of the parameter or null
defaultValue
- the default valuerequired
- whether the parameter is required e.g. it cannot an empty stringvalueConstraint
- the value constraint if relevant or null
Operator.Builder addParameterGroup(java.lang.String name, java.lang.String label, java.lang.String description, java.lang.String type, java.util.List<java.lang.String> parameters, java.lang.String parentGroup)
name
- the group name which should be unique within an operatorlabel
- the group labeldescription
- the group descriptiontype
- the group type or null
parameters
- the list of parameter names to be included in this groupparentGroup
- the name of the parent group or null
for a primary groupValueConstraint newEnumerationConstraint(java.util.List<java.lang.String> values)
values
- the valid values in the enumerationValueConstraint newRangeConstraint(java.lang.Number lowerBound, java.lang.Number upperBound)
lowerBound
- the lower bound or null
if there is no lower boundupperBound
- the upper bound or null
if there is no upper boundValueConstraint.StructureBuilder newStructureConstraintBuilder()
Operator build()
(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.