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
Interface ICleanUp


public interface ICleanUp

A clean up solves problems in a compilation unit.

The clean up is asked for its requirements through a call to getRequirements(). The clean up can request an AST and define how to build this AST. It can base its requirements on the options passed through setOptions(CleanUpOptions).

A context containing the information requested by the requirements are passed to createFix(CleanUpContext). A fix capable of fixing the problems is returned by this function if checkPreConditions(IJavaProject, ICompilationUnit[], IProgressMonitor) has returned a non fatal error status.

At the end checkPostConditions(IProgressMonitor) is called.

Since:
3.5

Method Summary
  RefactoringStatus checkPostConditions ( IProgressMonitor monitor)
          Called when done cleaning up.
  RefactoringStatus checkPreConditions ( IJavaProject project, ICompilationUnit[] compilationUnits, IProgressMonitor monitor)
          After call to checkPreConditions clients will start creating fixes for compilationUnits in project unless the result of checkPreConditions contains a fatal error
  ICleanUpFix createFix ( CleanUpContext context)
          Create an ICleanUpFix which fixes all problems in context or null if nothing to fix.
  CleanUpRequirements getRequirements ()
          The requirements of this clean up.
  String[] getStepDescriptions ()
          Human readable description for each step this clean up will execute.
 void setOptions ( CleanUpOptions options)
          Sets the options that will be used.
 

Method Detail

setOptions

void setOptions(
CleanUpOptions options)
Sets the options that will be used.

Parameters:
options - the options to use

getStepDescriptions

String[] getStepDescriptions()
Human readable description for each step this clean up will execute.

Note: This method must only be called after the options have been set.

Returns:
descriptions an array of strings or null

getRequirements

CleanUpRequirements getRequirements()
The requirements of this clean up.

Note: This method must only be called after the options have been set.

Returns:
the requirements used for createFix(CleanUpContext) to work

checkPreConditions

RefactoringStatus checkPreConditions(
IJavaProject project,
                                     
ICompilationUnit[] compilationUnits,
                                     
IProgressMonitor monitor)
                                     throws 
CoreException
After call to checkPreConditions clients will start creating fixes for compilationUnits in project unless the result of checkPreConditions contains a fatal error

Parameters:
project - the project to clean up
compilationUnits - an array of compilation units to clean up, all member of project
monitor - the monitor to show progress
Returns:
the result of the precondition check
Throws:
CoreException - if an unexpected error occurred

createFix

ICleanUpFix createFix(
CleanUpContext context)
                      throws 
CoreException
Create an ICleanUpFix which fixes all problems in context or null if nothing to fix.

Parameters:
context - a context containing all information requested by getRequirements()
Returns:
the fix for the problems or null if nothing to fix
Throws:
CoreException - if an unexpected error occurred

checkPostConditions

RefactoringStatus checkPostConditions(
IProgressMonitor monitor)
                                      throws 
CoreException
Called when done cleaning up.

Parameters:
monitor - the monitor to show progress
Returns:
the result of the postcondition check, not null
Throws:
CoreException - if an unexpected error occurred

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