Package com.ensoftcorp.open.commons.codemap

Class PrioritizedCodemapStage

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      abstract java.lang.String[] getCodemapStageDependencies()
      Returns a set of prioritized codemap stage identifier strings that should perform indexing before this prioritized codemap stage Note: this should represent a conservative set of the worst case dependencies.
      abstract java.lang.String getDisplayName()
      Returns the display name of the codemap stage
      abstract java.lang.String getIdentifier()
      A unique string that serves as the identity of this PrioritizedCodemapStage
      int hashCode()  
      abstract boolean performIndexing​(org.eclipse.core.runtime.IProgressMonitor monitor)
      The codemap stage indexing task to be performed.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • PrioritizedCodemapStage

        public PrioritizedCodemapStage()

    • Method Detail

      • getDisplayName

        public abstract java.lang.String getDisplayName()
        Returns the display name of the codemap stage
        Returns:

      • getIdentifier

        public abstract java.lang.String getIdentifier()
        A unique string that serves as the identity of this PrioritizedCodemapStage
        Returns:

      • getCodemapStageDependencies

        public abstract java.lang.String[] getCodemapStageDependencies()
        Returns a set of prioritized codemap stage identifier strings that should perform indexing before this prioritized codemap stage Note: this should represent a conservative set of the worst case dependencies. That is, if it is possible that under some configuration of the toolbox that the toolbox could depend on a prioritized codemap stage, then it should be listed here. Note: mutual dependencies are not supported!
        Returns:

      • performIndexing

        public abstract boolean performIndexing​(org.eclipse.core.runtime.IProgressMonitor monitor)
        The codemap stage indexing task to be performed.
        Parameters:
        monitor -
        Returns:
        Returns true if the codemap stage was actually run.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object