Class DescribableEntity

    • Constructor Detail

      • DescribableEntity

        public DescribableEntity()
    • Method Detail

      • fromJSONObject

        public void fromJSONObject​(jakarta.json.JsonObject jsonObj)
                            throws IOException
        Extract the metadata from the JSON object. This method first calls clear()
        Overrides:
        fromJSONObject in class AttributeableEntity
        Parameters:
        jsonObj - The JSON Object
        Throws:
        IOException - If JSON parsing fails
      • getTitle

        public String getTitle()
        Get the title
        Returns:
        The title or null
      • setTitle

        public void setTitle​(String title)
        Set the title
        Parameters:
        title - the title to set
      • getDescription

        public String getDescription()
        Get the description
        Returns:
        the description or null
      • setDescription

        public void setDescription​(String description)
        Set the description
        Parameters:
        description - the description to set
      • getDeprecated

        public String getDeprecated()
        Get the deprecation text
        Returns:
        the deprecation text or null
      • setDeprecated

        public void setDeprecated​(String deprecated)
        Set the deprecation text
        Parameters:
        deprecated - the deprecation text to set
      • getSince

        public String getSince()
        Get the optional since information
        Returns:
        The since information or null
      • setSince

        public void setSince​(String since)
        Set the since information. This should a date in the format 'YYYY-MM-DD'.
        Parameters:
        since - The new info
      • getEnforceOn

        public String getEnforceOn()
        Get the optional since information
        Returns:
        The since information or null
      • setEnforceOn

        public void setEnforceOn​(String enforceOn)
        Set the enforce on information.
        Parameters:
        enforceOn - The new info