Class StructureCheckerDescriptor

    • Constructor Detail

    • Method Detail

      • getIdentifier

        public String getIdentifier()
        Returns the checker identifier
        Returns:
        the checker identifier
      • setIdentifier

        public void setIdentifier​(String checkerId)
        Sets the checker identifier
        Parameters:
        checkerId - the checker identifier
      • getName

        public String getName()
        Returns the checker name
        Returns:
        the checker name
      • setName

        public void setName​(String name)
        Sets the checker name
        Parameters:
        name - the new name
      • getLocalMenuName

        public String getLocalMenuName()
        Returns the local menu name
        Returns:
        the local menu name
      • setLocalMenuName

        public void setLocalMenuName​(String localMenuName)
        Sets the local menu name of the concerning checker
        Parameters:
        localMenuName - is a String object which represents the local menu name of the concerning checker
      • getNoErrorMessage

        public String getNoErrorMessage()
        Returns the no error message of the concerning checker
        Returns:
        the no error message
      • setNoErrorMessage

        public void setNoErrorMessage​(String noErrorMessage)
        Sets the no error message of the concerning checker
        Parameters:
        noErrorMessage - is a String object which represents the message given by the concerned checker is no error found
      • getOneErrorMessage

        public String getOneErrorMessage()
        Returns the one error message
        Returns:
        the one error message
      • setOneErrorMessage

        public void setOneErrorMessage​(String oneErrorMessage)
        Sets the one error message of the concerning checker
        Parameters:
        oneErrorMessage - is a String object which represents the message given by the concerned checker if one error found
      • getMoreErrorMessage

        public String getMoreErrorMessage()
        Returns the more error message
        Returns:
        the more error message
      • setMoreErrorMessage

        public void setMoreErrorMessage​(String moreErrorMessage)
        Sets the more error message of the concerning checker
        Parameters:
        moreErrorMessage - is a String object which represents the message given by the concerned checker if more than one error found
      • getHelpText

        public String getHelpText()
        Returns the help text
        Returns:
        the help text
      • setHelpText

        public void setHelpText​(String helpText)
        Sets the help text of the concerning checker
        Parameters:
        helpText - is a String object which represents the detailed help text of the concerning checker
      • getDescription

        public String getDescription()
        Returns the description
        Returns:
        the description
      • setDescription

        public void setDescription​(String description)
        Sets the description of the concerning checker
        Parameters:
        description - is a String object which represents the description of the concerning checker
      • getIconPath

        public String getIconPath()
        Returns the icon path
        Returns:
        the icon path
      • setIconPath

        public void setIconPath​(String iconPath)
        Sets the icon path
        Parameters:
        iconPath - represents the path of the icon image as a String object
      • getEditorClassName

        public String getEditorClassName()
        Returns the editorClassName
        Returns:
        the editorClassName
      • setEditorClassName

        public void setEditorClassName​(String editorClassName)
        Sets the editorClassName
        Parameters:
        editorClassName - the editorClassName to set
      • getCustomName

        public String getCustomName()
        Returns the customName
        Returns:
        the customName
      • setCustomName

        public void setCustomName​(String customName)
        Sets the customName
        Parameters:
        customName - the customName to set
      • getFixMode

        public FixMode getFixMode()
        Returns the fixMode
        Returns:
        the fixMode
      • setFixMode

        public void setFixMode​(FixMode fixMode)
        Sets the fixMode
        Parameters:
        fixMode - the fixMode to set
      • getFixerClassName

        public String getFixerClassName()
        Returns the fixerClassName
        Returns:
        the fixerClassName
      • setFixerClassName

        public void setFixerClassName​(String fixerClassName)
        Sets the fixerClassName
        Parameters:
        fixerClassName - the fixerClassName to set
      • getSeverity

        public CheckerSeverity getSeverity()
        Returns the severity
        Returns:
        the severity
      • setSeverity

        public void setSeverity​(CheckerSeverity severity)
        Sets the severity of the concerning checker
        Parameters:
        severity - is an instance of CheckerSeverity which represents the severity of the concerning checker
      • getActionStringTokens

        public String[] getActionStringTokens()
        Gets the action string token of the checker
        Returns:
        the action string token of the checker
      • setActionStringTokens

        public void setActionStringTokens​(String[] actionStringTokens)
        Sets the action string token of the checker
        Parameters:
        actionStringTokens - the action string tokens of the checker
      • addPropertyChangeListener

        public void addPropertyChangeListener​(PropertyChangeListener listener)
        Add a PropertyChangeListener to the listener list. The listener is registered for all properties. The same listener object may be added more than once, and will be called as many times as it is added. If listener is null, no exception is thrown and no action is taken.
        Parameters:
        listener - The PropertyChangeListener to be added
      • removePropertyChangeListener

        public void removePropertyChangeListener​(PropertyChangeListener listener)
        Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties. If listener was added more than once to the same event source, it will be notified one less time after being removed. If listener is null, or was never added, no exception is thrown and no action is taken.
        Parameters:
        listener - The PropertyChangeListener to be removed
      • addPropertyChangeListener

        public void addPropertyChangeListener​(String propertyName,
                                              PropertyChangeListener listener)
        Add a PropertyChangeListener for a specific property. The listener will be invoked only when a call on firePropertyChange names that specific property. The same listener object may be added more than once. For each property, the listener will be invoked the number of times it was added for that property. If propertyName or listener is null, no exception is thrown and no action is taken.
        Parameters:
        propertyName - The name of the property to listen on.
        listener - The PropertyChangeListener to be added
      • removePropertyChangeListener

        public void removePropertyChangeListener​(String propertyName,
                                                 PropertyChangeListener listener)
        Remove a PropertyChangeListener for a specific property. If listener was added more than once to the same event source for the specified property, it will be notified one less time after being removed. If propertyName is null, no exception is thrown and no action is taken. If listener is null, or was never added for the specified property, no exception is thrown and no action is taken.
        Parameters:
        propertyName - The name of the property that was listened on.
        listener - The PropertyChangeListener to be removed
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getIcon

        public Icon getIcon()
        Returns the Icon related to iconPath property
        Returns:
        the Icon related to iconPath property