Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse JDT
Release 3.5

org.eclipse.jdt.ui.cleanup
Class CleanUpRequirements

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

public final class CleanUpRequirements
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

Eclipse JDT
Release 3.5

Copyright (c) IBM Corp. and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire