org.netbeans.modules.refactoring.java.api

Class JavaMoveMembersProperties

java.lang.Object

org.netbeans.modules.refactoring.java.api.JavaMoveMembersProperties

public final class JavaMoveMembersProperties
extends Object

This class is just holder for properties of the Java Move Members Refactoring. Refactoring itself is implemented in plugins.

Since:

1.31

See Also:

MoveRefactoring, Context

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaMoveMembersProperties.Visibility Used to specify visibility level.

Constructor Summary

Constructors

Constructor and Description
JavaMoveMembersProperties(TreePathHandle... preSelectedMembers) Constructs a new JavaMoveMembersProperties object.

Method Summary

Modifier and Type	Method and Description
TreePathHandle[]	getPreSelectedMembers() The members that are selected by the user when starting the refactoring.
JavaMoveMembersProperties.Visibility	getVisibility() The new visibility of the members.
boolean	isAddDeprecated() Add a deprecated tag to the JavaDoc of the delegating method.
boolean	isDelegate() Leave the old method in place and let it delegate to the new location.
boolean	isUpdateJavaDoc() Update or create the JavaDoc for moved methods.
void	setAddDeprecated(boolean addDeprecated) Add a deprecated tag to the JavaDoc of the delegating method.
void	setDelegate(boolean delegate) Leave the old method in place and let it delegate to the new location.
void	setUpdateJavaDoc(boolean updateJavaDoc) Add a deprecated tag to the javadoc of the delegating method.
void	setVisibility(JavaMoveMembersProperties.Visibility visibility) The new visibility of the members.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaMoveMembersProperties

public JavaMoveMembersProperties(@NonNull
                                 TreePathHandle... preSelectedMembers)

Constructs a new JavaMoveMembersProperties object.

Method Detail

getPreSelectedMembers

@NonNull
public TreePathHandle[] getPreSelectedMembers()

The members that are selected by the user when starting the refactoring.

Returns:

TreePathHandle array with the size of 1 or more.

getVisibility

@NonNull
public JavaMoveMembersProperties.Visibility getVisibility()

The new visibility of the members.

Returns:

visibility

setVisibility

public void setVisibility(@NonNull
                          JavaMoveMembersProperties.Visibility visibility)

The new visibility of the members.

Parameters:

visibility - the visibility to use

isDelegate

public boolean isDelegate()

Leave the old method in place and let it delegate to the new location. All references to the method will not be touched.

Returns:

true if the old method will delegate to the new location, false otherwise

setDelegate

public void setDelegate(boolean delegate)

Leave the old method in place and let it delegate to the new location. All references to the method will not be touched.

Parameters:

delegate - true if the old method needs delegate to the new location

isAddDeprecated

public boolean isAddDeprecated()

Add a deprecated tag to the JavaDoc of the delegating method.

Returns:

true if a deprecated tag needs to be added, false otherwise

setAddDeprecated

public void setAddDeprecated(boolean addDeprecated)

Add a deprecated tag to the JavaDoc of the delegating method.

Parameters:

addDeprecated - true if a deprecated tag has to be added to the delegate method

isUpdateJavaDoc

public boolean isUpdateJavaDoc()

Update or create the JavaDoc for moved methods.

Returns:

true if JavaDoc will be created or the existing will be updated, false otherwise

setUpdateJavaDoc

public void setUpdateJavaDoc(boolean updateJavaDoc)

Add a deprecated tag to the javadoc of the delegating method.

Parameters:

updateJavaDoc - true if the method's JavaDoc needs to be created or updated.