Module org.mule.runtime.extensions.api
Package org.mule.runtime.extension.api.model.parameter

Class ImmutableParameterModel

java.lang.Object
org.mule.runtime.extension.api.model.AbstractImmutableModel
org.mule.runtime.extension.api.model.AbstractNamedImmutableModel
org.mule.runtime.extension.api.model.parameter.ImmutableParameterModel
All Implemented Interfaces:
org.mule.runtime.api.meta.DescribedObject, org.mule.runtime.api.meta.model.declaration.fluent.HasSemanticTerms, org.mule.runtime.api.meta.model.deprecated.DeprecableModel, org.mule.runtime.api.meta.model.display.HasDisplayModel, org.mule.runtime.api.meta.model.display.HasLayoutModel, org.mule.runtime.api.meta.model.EnrichableModel, org.mule.runtime.api.meta.model.parameter.ParameterModel, org.mule.runtime.api.meta.model.version.HasMinMuleVersion, org.mule.runtime.api.meta.NamedObject, org.mule.runtime.api.meta.Typed
public final class ImmutableParameterModel extends AbstractNamedImmutableModel implements org.mule.runtime.api.meta.model.parameter.ParameterModel
Immutable implementation of ParameterModel
Since:
1.0

  • Field Summary

    Fields inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

    description, modelProperties

  • Constructor Summary

    Constructors
    Constructor
    Description
    ImmutableParameterModel(String name, String description, org.mule.metadata.api.model.MetadataType type, boolean hasDynamicType, boolean required, boolean isConfigOverride, boolean isComponentId, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, Object defaultValue, org.mule.runtime.api.meta.model.parameter.ParameterRole role, org.mule.runtime.api.meta.model.ParameterDslConfiguration dslConfiguration, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.display.LayoutModel layoutModel, org.mule.runtime.api.meta.model.parameter.ValueProviderModel valueProviderModel, List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypeModels, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)
    Creates a new instance with the given state
    ImmutableParameterModel(String name, String description, org.mule.metadata.api.model.MetadataType type, boolean hasDynamicType, boolean required, boolean isConfigOverride, boolean isComponentId, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, Object defaultValue, org.mule.runtime.api.meta.model.parameter.ParameterRole role, org.mule.runtime.api.meta.model.ParameterDslConfiguration dslConfiguration, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.display.LayoutModel layoutModel, org.mule.runtime.api.meta.model.parameter.ValueProviderModel valueProviderModel, List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypeModels, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel)
    Creates a new instance with the given state
    ImmutableParameterModel(String name, String description, org.mule.metadata.api.model.MetadataType type, boolean hasDynamicType, boolean required, boolean isConfigOverride, boolean isComponentId, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, Object defaultValue, org.mule.runtime.api.meta.model.parameter.ParameterRole role, org.mule.runtime.api.meta.model.ParameterDslConfiguration dslConfiguration, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.display.LayoutModel layoutModel, org.mule.runtime.api.meta.model.parameter.ValueProviderModel valueProviderModel, List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypeModels, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel, Set<String> semanticTerms, List<org.mule.runtime.api.meta.model.parameter.FieldValueProviderModel> fieldValueProviderModels)
    Creates a new instance with the given state
    ImmutableParameterModel(String name, String description, org.mule.metadata.api.model.MetadataType type, boolean hasDynamicType, boolean required, boolean isConfigOverride, boolean isComponentId, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, Object defaultValue, org.mule.runtime.api.meta.model.parameter.ParameterRole role, org.mule.runtime.api.meta.model.ParameterDslConfiguration dslConfiguration, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.display.LayoutModel layoutModel, org.mule.runtime.api.meta.model.parameter.ValueProviderModel valueProviderModel, List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypeModels, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel, Set<String> semanticTerms, List<org.mule.runtime.api.meta.model.parameter.FieldValueProviderModel> fieldValueProviderModels, org.mule.runtime.api.meta.MuleVersion minMuleVersion)
    Creates a new instance with the given state
    ImmutableParameterModel(String name, String description, org.mule.metadata.api.model.MetadataType type, boolean hasDynamicType, boolean required, boolean isConfigOverride, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, Object defaultValue, org.mule.runtime.api.meta.model.parameter.ParameterRole role, org.mule.runtime.api.meta.model.ParameterDslConfiguration dslConfiguration, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.display.LayoutModel layoutModel, org.mule.runtime.api.meta.model.parameter.ValueProviderModel valueProviderModel, List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypeModels, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)
    Deprecated.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel>
    getAllowedStereotypes()
    Object
    getDefaultValue()
    Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel>
    getDeprecationModel()
     
    org.mule.runtime.api.meta.model.ParameterDslConfiguration
    getDslConfiguration()
    org.mule.runtime.api.meta.ExpressionSupport
    getExpressionSupport()
    List<org.mule.runtime.api.meta.model.parameter.FieldValueProviderModel>
    getFieldValueProviderModels()
     
    Optional<org.mule.runtime.api.meta.model.display.LayoutModel>
    getLayoutModel()
    Optional<org.mule.runtime.api.meta.MuleVersion>
    getMinMuleVersion()
    org.mule.runtime.api.meta.model.parameter.ParameterRole
    getRole()
    Set<String>
    getSemanticTerms()
    org.mule.metadata.api.model.MetadataType
    getType()
    Optional<org.mule.runtime.api.meta.model.parameter.ValueProviderModel>
    getValueProviderModel()
    boolean
    hasDynamicType()
     
    boolean
    isComponentId()
    boolean
    isDeprecated()
     
    boolean
    isOverrideFromConfig()
    boolean
    isRequired()
    String
    toString()
     

    Methods inherited from class org.mule.runtime.extension.api.model.AbstractNamedImmutableModel

    checkArgument, equals, getDisplayModel, getName, hashCode

    Methods inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

    copy, copy, getDescription, getModelProperties, getModelProperty

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.mule.runtime.api.meta.DescribedObject

    getDescription

    Methods inherited from interface org.mule.runtime.api.meta.model.EnrichableModel

    getModelProperties, getModelProperty

    Methods inherited from interface org.mule.runtime.api.meta.model.display.HasDisplayModel

    getDisplayModel

    Methods inherited from interface org.mule.runtime.api.meta.NamedObject

    getName

  • Constructor Details

    • ImmutableParameterModel

      @Deprecated public ImmutableParameterModel(String name, String description, org.mule.metadata.api.model.MetadataType type, boolean hasDynamicType, boolean required, boolean isConfigOverride, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, Object defaultValue, org.mule.runtime.api.meta.model.parameter.ParameterRole role, org.mule.runtime.api.meta.model.ParameterDslConfiguration dslConfiguration, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.display.LayoutModel layoutModel, org.mule.runtime.api.meta.model.parameter.ValueProviderModel valueProviderModel, List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypeModels, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)
      Deprecated.
      Creates a new instance with the given state
      Parameters:
      name - the parameter's name. Cannot be blank.
      description - the parameter's description
      type - the parameter's MetadataType. Cannot be null
      hasDynamicType - if the given type is of dynamic kind and has to be discovered during design time
      required - whether this parameter is required or not
      expressionSupport - the ExpressionSupport that applies to this ParameterModel
      defaultValue - this parameter's default value
      role - this parameter's purpose
      dslConfiguration - a model which describes the DSL semantics for this parameter
      displayModel - a model which contains directive about how the parameter is displayed in the UI
      layoutModel - a model which contains directives about the parameter's layout in the UI
      allowedStereotypeModels - A Set with the stereotypes of the allowed values
      modelProperties - A Set of custom properties which extend this model
      Throws:
      IllegalArgumentException - if required is true and defaultValue is not null at the same time

    • ImmutableParameterModel

      public ImmutableParameterModel(String name, String description, org.mule.metadata.api.model.MetadataType type, boolean hasDynamicType, boolean required, boolean isConfigOverride, boolean isComponentId, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, Object defaultValue, org.mule.runtime.api.meta.model.parameter.ParameterRole role, org.mule.runtime.api.meta.model.ParameterDslConfiguration dslConfiguration, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.display.LayoutModel layoutModel, org.mule.runtime.api.meta.model.parameter.ValueProviderModel valueProviderModel, List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypeModels, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)
      Creates a new instance with the given state
      Parameters:
      name - the parameter's name. Cannot be blank.
      description - the parameter's description
      type - the parameter's MetadataType. Cannot be null
      hasDynamicType - if the given type is of dynamic kind and has to be discovered during design time
      required - whether this parameter is required or not
      isConfigOverride - whether this parameter is a configuration override or not
      isComponentId - whether this parameter serves as a ComponentModel ID or not
      expressionSupport - the ExpressionSupport that applies to this ParameterModel
      defaultValue - this parameter's default value
      role - this parameter's purpose
      dslConfiguration - a model which describes the DSL semantics for this parameter
      displayModel - a model which contains directive about how the parameter is displayed in the UI
      layoutModel - a model which contains directives about the parameter's layout in the UI
      allowedStereotypeModels - A Set with the stereotypes of the allowed values
      modelProperties - A Set of custom properties which extend this model
      Throws:
      IllegalArgumentException - if required is true and defaultValue is not null at the same time

    • ImmutableParameterModel

      public ImmutableParameterModel(String name, String description, org.mule.metadata.api.model.MetadataType type, boolean hasDynamicType, boolean required, boolean isConfigOverride, boolean isComponentId, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, Object defaultValue, org.mule.runtime.api.meta.model.parameter.ParameterRole role, org.mule.runtime.api.meta.model.ParameterDslConfiguration dslConfiguration, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.display.LayoutModel layoutModel, org.mule.runtime.api.meta.model.parameter.ValueProviderModel valueProviderModel, List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypeModels, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel)
      Creates a new instance with the given state
      Parameters:
      name - the parameter's name. Cannot be blank.
      description - the parameter's description
      type - the parameter's MetadataType. Cannot be null
      hasDynamicType - if the given type is of dynamic kind and has to be discovered during design time
      required - whether this parameter is required or not
      isConfigOverride - whether this parameter is a configuration override or not
      isComponentId - whether this parameter serves as a ComponentModel ID or not
      expressionSupport - the ExpressionSupport that applies to this ParameterModel
      defaultValue - this parameter's default value
      role - this parameter's purpose
      dslConfiguration - a model which describes the DSL semantics for this parameter
      displayModel - a model which contains directive about how the parameter is displayed in the UI
      layoutModel - a model which contains directives about the parameter's layout in the UI
      valueProviderModel - a value provider model
      allowedStereotypeModels - A Set with the stereotypes of the allowed values
      modelProperties - A Set of custom properties which extend this model
      deprecationModel - a DeprecationModel describing if the parameter is deprecated. A null value means it is not deprecated.
      Throws:
      IllegalArgumentException - if required is true and defaultValue is not null at the same time

    • ImmutableParameterModel

      public ImmutableParameterModel(String name, String description, org.mule.metadata.api.model.MetadataType type, boolean hasDynamicType, boolean required, boolean isConfigOverride, boolean isComponentId, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, Object defaultValue, org.mule.runtime.api.meta.model.parameter.ParameterRole role, org.mule.runtime.api.meta.model.ParameterDslConfiguration dslConfiguration, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.display.LayoutModel layoutModel, org.mule.runtime.api.meta.model.parameter.ValueProviderModel valueProviderModel, List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypeModels, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel, Set<String> semanticTerms, List<org.mule.runtime.api.meta.model.parameter.FieldValueProviderModel> fieldValueProviderModels)
      Creates a new instance with the given state
      Parameters:
      name - the parameter's name. Cannot be blank.
      description - the parameter's description
      type - the parameter's MetadataType. Cannot be null
      hasDynamicType - if the given type is of dynamic kind and has to be discovered during design time
      required - whether this parameter is required or not
      isConfigOverride - whether this parameter is a configuration override or not
      isComponentId - whether this parameter serves as a ComponentModel ID or not
      expressionSupport - the ExpressionSupport that applies to this ParameterModel
      defaultValue - this parameter's default value
      role - this parameter's purpose
      dslConfiguration - a model which describes the DSL semantics for this parameter
      displayModel - a model which contains directive about how the parameter is displayed in the UI
      layoutModel - a model which contains directives about the parameter's layout in the UI
      valueProviderModel - a value provider model
      allowedStereotypeModels - A Set with the stereotypes of the allowed values
      modelProperties - A Set of custom properties which extend this model
      deprecationModel - a DeprecationModel describing if the parameter is deprecated. A null value means it is not deprecated.
      semanticTerms - a Set of semantic terms which describe the parameter's meaning and effect
      fieldValueProviderModels - List of field value provider models.
      Throws:
      IllegalArgumentException - if required is true and defaultValue is not null at the same time
      Since:
      1.4.0

    • ImmutableParameterModel

      public ImmutableParameterModel(String name, String description, org.mule.metadata.api.model.MetadataType type, boolean hasDynamicType, boolean required, boolean isConfigOverride, boolean isComponentId, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, Object defaultValue, org.mule.runtime.api.meta.model.parameter.ParameterRole role, org.mule.runtime.api.meta.model.ParameterDslConfiguration dslConfiguration, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.display.LayoutModel layoutModel, org.mule.runtime.api.meta.model.parameter.ValueProviderModel valueProviderModel, List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypeModels, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel, Set<String> semanticTerms, List<org.mule.runtime.api.meta.model.parameter.FieldValueProviderModel> fieldValueProviderModels, org.mule.runtime.api.meta.MuleVersion minMuleVersion)
      Creates a new instance with the given state
      Parameters:
      name - the parameter's name. Cannot be blank.
      description - the parameter's description
      type - the parameter's MetadataType. Cannot be null
      hasDynamicType - if the given type is of dynamic kind and has to be discovered during design time
      required - whether this parameter is required or not
      isConfigOverride - whether this parameter is a configuration override or not
      isComponentId - whether this parameter serves as a ComponentModel ID or not
      expressionSupport - the ExpressionSupport that applies to this ParameterModel
      defaultValue - this parameter's default value
      role - this parameter's purpose
      dslConfiguration - a model which describes the DSL semantics for this parameter
      displayModel - a model which contains directive about how the parameter is displayed in the UI
      layoutModel - a model which contains directives about the parameter's layout in the UI
      valueProviderModel - a value provider model
      allowedStereotypeModels - A Set with the stereotypes of the allowed values
      modelProperties - A Set of custom properties which extend this model
      deprecationModel - a DeprecationModel describing if the parameter is deprecated. A null value means it is not deprecated.
      semanticTerms - a Set of semantic terms which describe the parameter's meaning and effect
      fieldValueProviderModels - List of field value provider models.
      minMuleVersion - the min mule version of the parameter
      Throws:
      IllegalArgumentException - if required is true and defaultValue is not null at the same time
      Since:
      1.5.0

  • Method Details

    • getType

      public org.mule.metadata.api.model.MetadataType getType()
      Specified by:
      getType in interface org.mule.runtime.api.meta.Typed

    • hasDynamicType

      public boolean hasDynamicType()
      Specified by:
      hasDynamicType in interface org.mule.runtime.api.meta.Typed

    • isRequired

      public boolean isRequired()
      Specified by:
      isRequired in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

    • isOverrideFromConfig

      public boolean isOverrideFromConfig()
      Specified by:
      isOverrideFromConfig in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

    • getExpressionSupport

      public org.mule.runtime.api.meta.ExpressionSupport getExpressionSupport()
      Specified by:
      getExpressionSupport in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

    • getDefaultValue

      public Object getDefaultValue()
      Specified by:
      getDefaultValue in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

    • getDslConfiguration

      public org.mule.runtime.api.meta.model.ParameterDslConfiguration getDslConfiguration()
      Specified by:
      getDslConfiguration in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

    • getRole

      public org.mule.runtime.api.meta.model.parameter.ParameterRole getRole()
      Specified by:
      getRole in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

    • getLayoutModel

      public Optional<org.mule.runtime.api.meta.model.display.LayoutModel> getLayoutModel()
      Specified by:
      getLayoutModel in interface org.mule.runtime.api.meta.model.display.HasLayoutModel
      Specified by:
      getLayoutModel in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

    • getAllowedStereotypes

      public List<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> getAllowedStereotypes()
      Specified by:
      getAllowedStereotypes in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

    • getValueProviderModel

      public Optional<org.mule.runtime.api.meta.model.parameter.ValueProviderModel> getValueProviderModel()
      Specified by:
      getValueProviderModel in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

    • getFieldValueProviderModels

      public List<org.mule.runtime.api.meta.model.parameter.FieldValueProviderModel> getFieldValueProviderModels()
      Specified by:
      getFieldValueProviderModels in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

    • isComponentId

      public boolean isComponentId()
      Specified by:
      isComponentId in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

    • getDeprecationModel

      public Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel> getDeprecationModel()
      Specified by:
      getDeprecationModel in interface org.mule.runtime.api.meta.model.deprecated.DeprecableModel

    • isDeprecated

      public boolean isDeprecated()
      Specified by:
      isDeprecated in interface org.mule.runtime.api.meta.model.deprecated.DeprecableModel

    • getSemanticTerms

      public Set<String> getSemanticTerms()
      Specified by:
      getSemanticTerms in interface org.mule.runtime.api.meta.model.declaration.fluent.HasSemanticTerms
      Since:
      1.4.0

    • getMinMuleVersion

      public Optional<org.mule.runtime.api.meta.MuleVersion> getMinMuleVersion()
      Specified by:
      getMinMuleVersion in interface org.mule.runtime.api.meta.model.version.HasMinMuleVersion

    • toString

      public String toString()
      Overrides:
      toString in class AbstractNamedImmutableModel