Class RenameResourceDescriptor

    • Constructor Detail

      • RenameResourceDescriptor

        public RenameResourceDescriptor()
        Deprecated.
        Creates a new refactoring descriptor.
      • RenameResourceDescriptor

        public RenameResourceDescriptor​(String project,
                                        String description,
                                        String comment,
                                        Map<String,​String> arguments,
                                        int flags)
        Deprecated.
        Creates a new refactoring descriptor.
        Parameters:
        project - the non-empty name of the project associated with this refactoring, or null for a workspace refactoring
        description - a non-empty human-readable description of the particular refactoring instance
        comment - the human-readable comment of the particular refactoring instance, or null for no comment
        arguments - a map of arguments that will be persisted and describes all settings for this refactoring
        flags - the flags of the refactoring descriptor
        Throws:
        IllegalArgumentException - if the argument map contains invalid keys/values
        Since:
        1.2
    • Method Detail

      • setNewName

        public void setNewName​(String name)
        Deprecated.
        Sets the new name to rename the resource to.
        Parameters:
        name - the non-empty new name to set
      • getNewName

        public String getNewName()
        Deprecated.
        Returns the new name to rename the resource to.
        Returns:
        the new name to rename the resource to
        Since:
        1.2
      • setProject

        public void setProject​(String project)
        Deprecated.
        Sets the project name of this refactoring.

        Note: If the resource to be renamed is of type IResource.PROJECT, clients are required to to set the project name to null.

        The default is to associate the refactoring with the workspace.

        Overrides:
        setProject in class JavaRefactoringDescriptor
        Parameters:
        project - the non-empty project name to set, or null for the workspace
        See Also:
        RefactoringDescriptor.getProject()
      • setResource

        public void setResource​(IResource resource)
        Deprecated.
        Sets the resource to be renamed.

        Note: If the resource to be renamed is of type IResource.PROJECT, clients are required to to set the project name to null.

        Parameters:
        resource - the resource to be renamed
      • getResourcePath

        public IPath getResourcePath()
        Deprecated.
        Returns the path of the resource to rename.
        Returns:
        the path of the resource to rename
        Since:
        1.2
      • validateDescriptor

        public RefactoringStatus validateDescriptor()
        Deprecated.
        Description copied from class: JavaRefactoringDescriptor
        Validates the refactoring descriptor with respect to the constraints imposed by the represented refactoring.

        Clients must call this method to verify that all arguments have been correctly set and that they satisfy the constraints imposed by specific refactorings. Returning a refactoring status of severity RefactoringStatus.FATAL indicates that the refactoring descriptor cannot be used to create a refactoring instance.

        Overrides:
        validateDescriptor in class JavaRefactoringDescriptor
        Returns:
        a refactoring status describing the outcome of the validation