RefactoringSession (Refactoring API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.refactoring.api 1.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.refactoring.api
Class RefactoringSession

java.lang.Object
  org.netbeans.modules.refactoring.api.RefactoringSession

public final class RefactoringSession
extends Object
extends Object

Class used to invoke refactorings.

Method Summary

void addProgressListener(ProgressListener listener)
          Adds progress listener to this RefactoringSession

static RefactoringSession create(String description)
          Creates a new refactoring session.

Problem doRefactoring(boolean saveAfterDone)
          process all elements from elements bags, do all fileChanges and call all commits

Collection<RefactoringElement> getRefactoringElements()
          get elements from session

void removeProgressListener(ProgressListener listener)
          Remove progress listener from this RefactoringSession

Problem undoRefactoring(boolean saveAfterDone)
          do undo of previous doRefactoring()

Methods inherited from class java.lang.Object

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

Method Summary
`void`	`addProgressListener(ProgressListener listener)` Adds progress listener to this RefactoringSession
`static RefactoringSession`	`create(String description)` Creates a new refactoring session.
`Problem`	`doRefactoring(boolean saveAfterDone)` process all elements from elements bags, do all fileChanges and call all commits
`Collection<RefactoringElement>`	`getRefactoringElements()` get elements from session
`void`	`removeProgressListener(ProgressListener listener)` Remove progress listener from this RefactoringSession
`Problem`	`undoRefactoring(boolean saveAfterDone)` do undo of previous doRefactoring()

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

create

public static RefactoringSession create(String description)

Creates a new refactoring session.

Parameters:: description - textual description of this session
Returns:: instance of RefactoringSession

doRefactoring

public Problem doRefactoring(boolean saveAfterDone)

process all elements from elements bags, do all fileChanges and call all commits

Parameters:: saveAfterDone - save all if true
Returns:: instance of Problem or null, if everything is OK

undoRefactoring

public Problem undoRefactoring(boolean saveAfterDone)

do undo of previous doRefactoring()

Parameters:: saveAfterDone - save all if true
Returns:: instance of Problem or null, if everything is OK

getRefactoringElements

public Collection<RefactoringElement> getRefactoringElements()

get elements from session

Returns:: collection of RefactoringElements

addProgressListener

public void addProgressListener(ProgressListener listener)

Adds progress listener to this RefactoringSession

Parameters:: listener - to add

removeProgressListener

public void removeProgressListener(ProgressListener listener)

Remove progress listener from this RefactoringSession

Parameters:: listener - to remove