Eclipse JDT Plug-in Developer Guide (Galileo) - CleanUpRequirements (Eclipse JDT API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse JDT
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jdt.ui.cleanup
Class CleanUpRequirements


java.lang.Object
  
org.eclipse.jdt.ui.cleanup.CleanUpRequirements

public final class CleanUpRequirements
extends Object
extends Object

Specifies the requirements of a clean up.

Since:: 3.5

Constructor Summary

CleanUpRequirements (boolean requiresAST, boolean requiresFreshAST, boolean requiresChangedRegions, Map compilerOptions)
          Create a new instance

Method Summary

Map getCompilerOptions ()
          Required compiler options.

boolean requiresAST ()
          Tells whether the clean up requires an AST.

boolean requiresChangedRegions ()
          Tells whether this clean up requires to be informed about changed regions.

boolean requiresFreshAST ()
          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

Constructor Detail

CleanUpRequirements

public CleanUpRequirements(boolean requiresAST,
                           boolean requiresFreshAST,
                           boolean requiresChangedRegions,
                           
Map compilerOptions)

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 Detail

requiresAST

public boolean requiresAST()

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 context must provide an AST

requiresFreshAST

public boolean requiresFreshAST()

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 getCompilerOptions()

Required compiler options.

Returns:: the compiler options map or null if none
See Also:: JavaCore

requiresChangedRegions

public boolean requiresChangedRegions()

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 context must provide changed regions