Package com.github.toolarium.processing.unit

Class ParameterDefinitionBuilder

  • public class ParameterDefinitionBuilder
extends java.lang.Object
    Defines a parameter definition builder: At least the parameter must define a key and a description.

    • Constructor Detail

      • ParameterDefinitionBuilder

        public ParameterDefinitionBuilder()
        Constructor for ParameterDefinitionBuilder

    • Method Detail

      • name

        public ParameterDefinitionBuilder name​(java.lang.String name)
        Set the parameter name.
        Parameters:
        name - the name
        Returns:
        this instance

      • description

        public ParameterDefinitionBuilder description​(java.lang.String description)
        Set the description
        Parameters:
        description - the description
        Returns:
        this instance

      • defaultValue

        public ParameterDefinitionBuilder defaultValue​(java.lang.Object defaultValue)
        Set the default value
        Parameters:
        defaultValue - the default value
        Returns:
        this instance

      • isOptional

        public ParameterDefinitionBuilder isOptional()
        Defines the parameter is optional (sets implicit the min occurs).
        Returns:
        this instance

      • isMandatory

        public ParameterDefinitionBuilder isMandatory()
        Defines the parameter is mandatory (sets implicit the min occurs).
        Returns:
        this instance

      • minOccurs

        public ParameterDefinitionBuilder minOccurs​(int minOccurs)
        Set the min occurs: The min occurs (zero minOccurs has the meaning of the value is optional)
        Parameters:
        minOccurs - the min occurs
        Returns:
        this instance

      • maxOccurs

        public ParameterDefinitionBuilder maxOccurs​(int maxOccurs)
        Set the max occurs
        Parameters:
        maxOccurs - the max occurs
        Returns:
        this instance

      • emptyValueIsAllowed

        public ParameterDefinitionBuilder emptyValueIsAllowed()
        Defines an empty value is allowed
        Returns:
        this instance

      • emptyValueIsNotAllowed

        public ParameterDefinitionBuilder emptyValueIsNotAllowed()
        Defines an empty value is not allowed
        Returns:
        this instance

      • hasValueToProtect

        public ParameterDefinitionBuilder hasValueToProtect()
        Define if the value must be protected, e.g. password / credentials
        Returns:
        this instance

      • build

        public ParameterDefinition build()
        Build the parameter definition
        Returns:
        the parameter definition

      • guessValueType

        public static ParameterValueType guessValueType​(ParameterValueType inputValueType,
                                                java.lang.Object inputDefaultValue)
        Guess the value type
        Parameters:
        inputValueType - the value type
        inputDefaultValue - the default value
        Returns:
        the resolved value type base on default value