org.netbeans.modules.refactoring.api

Class RefactoringSession

java.lang.Object

org.netbeans.modules.refactoring.api.RefactoringSession

public final class RefactoringSession
extends Object

Class used to invoke refactorings.

Method Summary

Modifier and Type	Method and Description
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
void	finished() Inform the session it, and all its plugins, are finished.
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

@NonNull
public static RefactoringSession create(@NonNull
                                                 String description)

Creates a new refactoring session.

Parameters:

description - textual description of this session

Returns:

instance of RefactoringSession

doRefactoring

@CheckForNull
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

@CheckForNull
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

@NonNull
public Collection<RefactoringElement> getRefactoringElements()

Get elements from session

Returns:

collection of RefactoringElements

Since:

1.23 the returned collection is blocking until finished.

See Also:

RefactoringSession.finished()

finished

public void finished()

Inform the session it, and all its plugins, are finished.

Since:

1.28

See Also:

RefactoringSession.getRefactoringElements()

addProgressListener

public void addProgressListener(@NonNull
                                ProgressListener listener)

Adds progress listener to this RefactoringSession

Parameters:

listener - to add

removeProgressListener

public void removeProgressListener(@NonNull
                                   ProgressListener listener)

Remove progress listener from this RefactoringSession

Parameters:

listener - to remove