Package com.ensoftcorp.open.commons.subsystems

Class SubsystemCodemapStage

  • public class SubsystemCodemapStage
extends PrioritizedCodemapStage
    Runs the subsystem tagging as a post indexing process
    Author:
    Ben Holland

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String IDENTIFIER
      The unique identifier for the Subsystem codemap stage

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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.
      java.lang.String getDisplayName()
      Returns the display name of the codemap stage
      java.lang.String getIdentifier()
      A unique string that serves as the identity of this PrioritizedCodemapStage
      boolean performIndexing​(org.eclipse.core.runtime.IProgressMonitor monitor)
      The codemap stage indexing task to be performed.

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • IDENTIFIER

        public static final java.lang.String IDENTIFIER
        The unique identifier for the Subsystem codemap stage
        See Also:
        Constant Field Values

    • Constructor Detail

      • SubsystemCodemapStage

        public SubsystemCodemapStage()

    • Method Detail

      • getCodemapStageDependencies

        public java.lang.String[] getCodemapStageDependencies()
        Description copied from class: PrioritizedCodemapStage
        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!
        Specified by:
        getCodemapStageDependencies in class PrioritizedCodemapStage
        Returns:

      • performIndexing

        public boolean performIndexing​(org.eclipse.core.runtime.IProgressMonitor monitor)
        Description copied from class: PrioritizedCodemapStage
        The codemap stage indexing task to be performed.
        Specified by:
        performIndexing in class PrioritizedCodemapStage
        Returns:
        Returns true if the codemap stage was actually run.