Class PropertyDefinitionMetadata

    • Constructor Detail

      • PropertyDefinitionMetadata

        public PropertyDefinitionMetadata()
    • Method Detail

      • isAdvanced

        public boolean isAdvanced()
        Description copied from interface: PropertyDefinition
        The "expert" flag is used to distinguish between features that are intended for expert users from those that are intended for normal users.
        Specified by:
        isAdvanced in interface PropertyDefinition
        Returns:
        true if this property is to be marked with the expert flag, or false otherwise.
        Since:
        4.3
        See Also:
        PropertyDefinition.isAdvanced()
      • isRequired

        public boolean isRequired()
        Description copied from interface: PropertyDefinition
        The "required" flag is used to identify features that require at least one value (possibly a default value) by the consumer of the property. Whether a property definition is required or not can be determined entirely from the multiplicity: if the multiplicity includes '0', then the property is not required.

        Whether a property is required by the consumer is unrelated to whether there is a default value, which only simplifies the task of the property provider. A property may be required, meaning it must have at least one value, but that same property definition may or may not have a default. The combination of required and whether it has a default will determine whether the user must supply a value.

        Specified by:
        isRequired in interface PropertyDefinition
        Returns:
        true if this property requires at least one value.
        See Also:
        PropertyDefinition.isRequired()
      • setAllowedValues

        public void setAllowedValues​(Collection allowedValues)
        Parameters:
        allowedValues - The allowedValues to set.
      • setDefaultValue

        public void setDefaultValue​(Serializable defaultValue)
        Parameters:
        defaultValue - The defaultValue to set.
      • setDescription

        public void setDescription​(String description)
        Parameters:
        description - The description to set.
      • setDisplayName

        public void setDisplayName​(String displayName)
        Parameters:
        displayName - The displayName to set.
      • setAdvanced

        public void setAdvanced​(boolean expert)
        Parameters:
        expert - The value of expert to set.
      • setMasked

        public void setMasked​(boolean masked)
        Parameters:
        masked - The value of masked to set.
      • setModifiable

        public void setModifiable​(boolean modifiable)
        Parameters:
        modifiable - The value of modifiable to set.
      • setPropertyTypeClassName

        public void setPropertyTypeClassName​(String propertyTypeClassName)
        Parameters:
        propertyTypeClassName - The propertyTypeName to set.
      • setRequired

        public void setRequired​(boolean required)
        Parameters:
        required - The value of required to set.
      • setRequiresRestart

        public void setRequiresRestart​(PropertyDefinition.RestartType requiresRestart)
        Parameters:
        requiresRestart - The value of requiresRestart to set.
      • setCategory

        public void setCategory​(String category)