Package org.eclipse.jdt.core.manipulation

Class CleanUpRequirementsCore

java.lang.Object
org.eclipse.jdt.core.manipulation.CleanUpRequirementsCore
@Deprecated(forRemoval=true, since="2024-06") public final class CleanUpRequirementsCore extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
Please use CleanUpRequirements in the future
Specifies the requirements of a clean up.
Since:
1.12

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final Map<String,String>
    fCompilerOptions
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected final boolean
    fRequiresAST
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected final boolean
    fRequiresChangedRegions
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected final boolean
    fRequiresFreshAST
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CleanUpRequirementsCore(boolean requiresAST, boolean requiresFreshAST, boolean requiresChangedRegions, Map<String,String> compilerOptions)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new instance

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    getCompilerOptions()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Required compiler options.
    boolean
    requiresAST()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Tells whether the clean up requires an AST.
    boolean
    requiresChangedRegions()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Tells whether this clean up requires to be informed about changed regions.
    boolean
    requiresFreshAST()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Tells whether a fresh AST, containing all the changes from previous clean ups, will be needed.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • fRequiresAST

      protected final boolean fRequiresAST
      Deprecated, for removal: This API element is subject to removal in a future version.

    • fCompilerOptions

      protected final Map<String,String> fCompilerOptions
      Deprecated, for removal: This API element is subject to removal in a future version.

    • fRequiresFreshAST

      protected final boolean fRequiresFreshAST
      Deprecated, for removal: This API element is subject to removal in a future version.

    • fRequiresChangedRegions

      protected final boolean fRequiresChangedRegions
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • CleanUpRequirementsCore

      public CleanUpRequirementsCore(boolean requiresAST, boolean requiresFreshAST, boolean requiresChangedRegions, Map<String,String> compilerOptions)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new instance
      Parameters:
      requiresAST - true if an AST is required
      requiresFreshAST - true if a fresh AST is required
      requiresChangedRegions - true if changed regions are required
      compilerOptions - map of compiler options or null if no requirements

  • Method Details

    • requiresAST

      public boolean requiresAST()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tells whether the clean up requires an AST.

      Note: This should return false whenever possible because creating an AST is expensive.

      Returns:
      true if the CleanUpContext context must provide an AST

    • requiresFreshAST

      public boolean requiresFreshAST()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tells whether a fresh AST, containing all the changes from previous clean ups, will be needed.
      Returns:
      true if the caller needs an up to date AST

    • getCompilerOptions

      public Map<String,String> getCompilerOptions()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Required compiler options.
      Returns:
      the compiler options map or null if none
      See Also:

    • requiresChangedRegions

      public boolean requiresChangedRegions()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tells whether this clean up requires to be informed about changed regions. The changed regions are the regions which have been changed between the last save state of the compilation unit and its current state.

      Has only an effect if the clean up is used as save action.

      Note:: This should return false whenever possible because calculating the changed regions is expensive.

      Returns:
      true if the CleanUpContext context must provide changed regions