Package org.eclipse.jdt.ui.refactoring

Class RefactoringSaveHelper

java.lang.Object
org.eclipse.jdt.ui.refactoring.RefactoringSaveHelper
public class RefactoringSaveHelper extends Object
Helper to save dirty editors prior to starting a refactoring.
Since:
3.5
See Also:
Restriction:
This class is not intended to be subclassed by clients.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    SAVE_ALL
    Save mode to save all dirty editors.
    static final int
    SAVE_ALL_ALWAYS_ASK
    Save mode to save all dirty editors (always ask).
    static final int
    SAVE_NOTHING
    Save mode to not save any editors.
    static final int
    SAVE_REFACTORING
    Save mode to save all editors that are known to cause trouble for Java refactorings, e.g.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RefactoringSaveHelper(int saveMode)
    Creates a refactoring save helper with the given save mode.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    didSaveFiles()
    Returns whether this save helper did actually save any files.
    boolean
    saveEditors(org.eclipse.swt.widgets.Shell shell)
    Saves all editors.
    void
    triggerIncrementalBuild()
    Triggers an incremental build if this save helper did save files before.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • SAVE_ALL_ALWAYS_ASK

      public static final int SAVE_ALL_ALWAYS_ASK
      Save mode to save all dirty editors (always ask).
      See Also:

    • SAVE_ALL

      public static final int SAVE_ALL
      Save mode to save all dirty editors.
      See Also:

    • SAVE_NOTHING

      public static final int SAVE_NOTHING
      Save mode to not save any editors.
      See Also:

    • SAVE_REFACTORING

      public static final int SAVE_REFACTORING
      Save mode to save all editors that are known to cause trouble for Java refactorings, e.g. editors on compilation units that are not in working copy mode.
      See Also:

  • Constructor Details

    • RefactoringSaveHelper

      public RefactoringSaveHelper(int saveMode)
      Creates a refactoring save helper with the given save mode.
      Parameters:
      saveMode - one of the SAVE_* constants

  • Method Details

    • saveEditors

      public boolean saveEditors(org.eclipse.swt.widgets.Shell shell)
      Saves all editors. Depending on the PreferenceConstants.REFACTOR_SAVE_ALL_EDITORS preference, the user is asked to save affected dirty editors.
      Parameters:
      shell - the parent shell for the confirmation dialog
      Returns:
      true if save was successful and refactoring can proceed; false if the refactoring must be cancelled

    • triggerIncrementalBuild

      public void triggerIncrementalBuild()
      Triggers an incremental build if this save helper did save files before.

    • didSaveFiles

      public boolean didSaveFiles()
      Returns whether this save helper did actually save any files.
      Returns:
      true iff files have been saved