Class ListTODOs

    • Field Detail

      • m_RegExp

        protected BaseRegExp m_RegExp
        the regular expression to use for matching the TODOs.
    • Constructor Detail

      • ListTODOs

        public ListTODOs()
    • Method Detail

      • setRegExp

        public void setRegExp​(BaseRegExp value)
        Sets the regular expression to use for locating TODOs.
        Parameters:
        value - the expression
      • getRegExp

        public BaseRegExp getRegExp()
        Returns the regular expression to use for locating TODOs.
        Returns:
        the expression
      • regExpTipText

        public String regExpTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • getTitle

        public String getTitle()
        Returns the title for the dialog.
        Returns:
        the title
      • isValid

        protected boolean isValid​(AbstractOption option,
                                  Object obj,
                                  OptionTraversalPath path)
        Checks whether the object is valid and should be added to the list.
        Specified by:
        isValid in class AbstractListingProcessor
        Parameters:
        option - the current option
        obj - the object to check
        path - the traversal path of properties
        Returns:
        true if valid
      • objectToString

        protected String objectToString​(AbstractOption option,
                                        Object obj,
                                        OptionTraversalPath path)
        Returns the string representation of the object that is added to the list.

        Default implementation only calls the toString() method.
        Overrides:
        objectToString in class AbstractListingProcessor
        Parameters:
        option - the current option
        obj - the object to turn into a string
        path - the traversal path of properties
        Returns:
        the string representation, null if to ignore the item
      • isSortedList

        protected boolean isSortedList()
        Returns whether the list should be sorted.
        Specified by:
        isSortedList in class AbstractListingProcessor
        Returns:
        true if the list should get sorted
      • isUniqueList

        protected boolean isUniqueList()
        Returns whether the list should not contain any duplicates.
        Specified by:
        isUniqueList in class AbstractListingProcessor
        Returns:
        true if the list contains no duplicates
      • getHeader

        protected String getHeader()
        Returns the header to use in the dialog, i.e., the one-liner that explains the output.
        Specified by:
        getHeader in class AbstractListingProcessor
        Returns:
        the header, null if no header available