org.eclipse.jdt.internal.corext.refactoring.reorg

Class JavaCopyProcessor [ source ]

java.lang.Object

org.eclipse.core.runtime.PlatformObject

org.eclipse.ltk.core.refactoring.participants.RefactoringProcessor

org.eclipse.ltk.core.refactoring.participants.CopyProcessor

org.eclipse.jdt.internal.corext.refactoring.reorg.JavaCopyProcessor

All Implemented Interfaces:

IAdaptable, IReorgDestinationValidator

public final class JavaCopyProcessor
extends CopyProcessor
implements IReorgDestinationValidator

Constructor Summary

Constructors

Constructor and Description
JavaCopyProcessor(IReorgPolicy.ICopyPolicy copyPolicy)
JavaCopyProcessor(JavaRefactoringArguments refactoringArguments, RefactoringStatus status)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canChildrenBeDestinations(IReorgDestination destination) Is it possible, that destination contains valid destinations as children?
boolean	canElementBeDestination(IReorgDestination destination) Is it possible, that the given kind of destination is a target for the reorg?
RefactoringStatus	checkFinalConditions(IProgressMonitor pm, CheckConditionsContext context) Checks the final conditions based on the element to be refactored.
RefactoringStatus	checkInitialConditions(IProgressMonitor pm) Checks some initial conditions based on the element to be refactored.
Change	createChange(IProgressMonitor pm) Creates a Change object describing the workspace modifications the processor contributes to the overall refactoring.
Object	getCommonParentForInputElements()
Object[]	getElements() Returns an array containing the elements to be refactored.
String	getIdentifier() Returns the unique identifier of the refactoring processor.
IJavaElement[]	getJavaElements()
String	getProcessorName() Returns a human readable name.
IResource[]	getResources()
int	getSaveMode()
boolean	isApplicable() Checks whether the processor is applicable to the elements to be refactored or not.
RefactoringParticipant[]	loadParticipants(RefactoringStatus status, SharableParticipants sharedParticipants) Returns the array of participants.
RefactoringStatus	setDestination(IReorgDestination destination)
void	setNewNameQueries(INewNameQueries newNameQueries)
void	setReorgQueries(IReorgQueries queries)

Methods inherited from class org.eclipse.ltk.core.refactoring.participants.RefactoringProcessor

getRefactoring, postCreateChange

Methods inherited from class org.eclipse.core.runtime.PlatformObject

getAdapter

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaCopyProcessor

public JavaCopyProcessor(IReorgPolicy.ICopyPolicy copyPolicy)

JavaCopyProcessor

public JavaCopyProcessor(JavaRefactoringArguments refactoringArguments,
                 RefactoringStatus status)

Method Detail

canChildrenBeDestinations

public boolean canChildrenBeDestinations(IReorgDestination destination)

Description copied from interface: IReorgDestinationValidator

Is it possible, that destination contains valid destinations as children?

Specified by:

canChildrenBeDestinations in interface IReorgDestinationValidator

Parameters:

destination - the destination to verify

Returns:

true if destination can have valid destinations

canElementBeDestination

public boolean canElementBeDestination(IReorgDestination destination)

Description copied from interface: IReorgDestinationValidator

Is it possible, that the given kind of destination is a target for the reorg?

Specified by:

canElementBeDestination in interface IReorgDestinationValidator

Parameters:

destination - the destination to verify

Returns:

true if possible

checkFinalConditions

public RefactoringStatus checkFinalConditions(IProgressMonitor pm,
                                     CheckConditionsContext context)
                                       throws CoreException

Description copied from class: RefactoringProcessor

Checks the final conditions based on the element to be refactored.

The refactoring using this processor is considered as not being executable if the returned status has the severity of RefactoringStatus#FATAL.

This method can be called more than once.

Specified by:

checkFinalConditions in class RefactoringProcessor

Parameters:

pm - a progress monitor to report progress

context - a condition checking context to collect shared condition checks

Returns:

a refactoring status. If the status is RefactoringStatus#FATAL the refactoring is considered as not being executable.

Throws:

CoreException - if an exception occurred during final condition checking. If this happens the final condition checking is interpreted as failed.

See Also:

Refactoring.checkFinalConditions(IProgressMonitor), RefactoringStatus.FATAL

checkInitialConditions

public RefactoringStatus checkInitialConditions(IProgressMonitor pm)
                                         throws CoreException

Description copied from class: RefactoringProcessor

Checks some initial conditions based on the element to be refactored.

The refactoring using this processor is considered as not being executable if the returned status has the severity of RefactoringStatus#FATAL.

This method can be called more than once.

Specified by:

checkInitialConditions in class RefactoringProcessor

Parameters:

pm - a progress monitor to report progress. Although availability checks are supposed to execute fast, there can be certain situations where progress reporting is necessary. For example rebuilding a corrupted index may report progress.

Returns:

a refactoring status. If the status is RefactoringStatus#FATAL the refactoring is considered as not being executable.

Throws:

CoreException - if an exception occurred during initial condition checking. If this happens the initial condition checking is interpreted as failed.

See Also:

Refactoring.checkInitialConditions(IProgressMonitor), RefactoringStatus.FATAL

createChange

public Change createChange(IProgressMonitor pm)
                    throws CoreException

Description copied from class: RefactoringProcessor

Creates a Change object describing the workspace modifications the processor contributes to the overall refactoring.

Specified by:

createChange in class RefactoringProcessor

Parameters:

pm - a progress monitor to report progress

Returns:

the change representing the workspace modifications of the processor

Throws:

CoreException - if an error occurred while creating the change

See Also:

Refactoring.createChange(IProgressMonitor)

getCommonParentForInputElements

public Object getCommonParentForInputElements()

getElements

public Object[] getElements()

Description copied from class: RefactoringProcessor

Returns an array containing the elements to be refactored. The concrete type of the elements depend on the concrete refactoring processor. For example a processor responsible for renaming Java methods returns the method to be renamed via this call.

Specified by:

getElements in class RefactoringProcessor

Returns:

an array containing the element to be refactored

getIdentifier

public String getIdentifier()

Description copied from class: RefactoringProcessor

Returns the unique identifier of the refactoring processor. The identifier must not be null.

Specified by:

getIdentifier in class RefactoringProcessor

Returns:

a unique identifier.

getJavaElements

public IJavaElement[] getJavaElements()

getProcessorName

public String getProcessorName()

Description copied from class: RefactoringProcessor

Returns a human readable name. The name will be displayed to users. The name must not be null.

Specified by:

getProcessorName in class RefactoringProcessor

Returns:

a human readable name

getResources

public IResource[] getResources()

isApplicable

public boolean isApplicable()
                     throws CoreException

Description copied from class: RefactoringProcessor

Checks whether the processor is applicable to the elements to be refactored or not. If false is returned the processor is interpreted to be unusable.

Specified by:

isApplicable in class RefactoringProcessor

Returns:

true if the processor is applicable to the elements; otherwise false is returned.

Throws:

CoreException - is the test fails. The processor is treated as unusable if this method throws an exception

loadParticipants

public RefactoringParticipant[] loadParticipants(RefactoringStatus status,
                                        SharableParticipants sharedParticipants)
                                          throws CoreException

Description copied from class: RefactoringProcessor

Returns the array of participants. It is up to the implementor of a concrete processor to define which participants are loaded. In general, three different kinds of participants can be distinguished:

• participants listening to the processed refactoring itself. For example if a Java field gets renamed all participants listening to Java field renames should be added via this hook.
• participants listening to changes of derived elements. For example if a Java field gets renamed corresponding setter and getters methods are renamed as well. The setter and getter methods are considered as derived elements and the corresponding participants should be added via this hook.
• participants listening to changes of a domain model different than the one that gets manipulated, but changed as a "side effect" of the refactoring. For example, renaming a package moves all its files to a different folder. If the package contains a HTML file then the rename package processor is supposed to load all move HTML file participants via this hook.

Implementors are responsible to initialize the created participants with the right arguments. The method is called after RefactoringProcessor.checkFinalConditions(IProgressMonitor, CheckConditionsContext)has been called on the processor itself.

Specified by:

loadParticipants in class RefactoringProcessor

Parameters:

status - a refactoring status to report status if problems occur while loading the participants

sharedParticipants - a list of sharable participants. Implementors of this method can simply pass this instance to the corresponding participant loading methods defined in ParticipantManager.

Returns:

an array of participants or null or an empty array if no participants are loaded

Throws:

CoreException - if creating or loading of the participants failed

See Also:

ISharableParticipant

setDestination

public RefactoringStatus setDestination(IReorgDestination destination)
                                 throws JavaModelException

Throws:

JavaModelException

setNewNameQueries

public void setNewNameQueries(INewNameQueries newNameQueries)

setReorgQueries

public void setReorgQueries(IReorgQueries queries)

getSaveMode

public int getSaveMode()