Package org.eclipse.ltk.core.refactoring.participants

Class DeleteArguments

  • public class DeleteArguments
extends RefactoringArguments
    Delete arguments describes the data that a processor provides to its delete participants.

    This class is not intended to be subclassed by clients.

    Since:
    3.0
    Restriction:
    This class is not intended to be subclassed by clients.

    • Constructor Summary

      Constructors 
      Constructor Description
      DeleteArguments()
      Creates a new delete arguments object (deleteProjectContents is false).
      DeleteArguments​(boolean deleteProjectContents)
      Creates a new delete arguments object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getDeleteProjectContents()
      Returns whether project contents will be deleted as well.
      java.lang.String toString()
      Returns a string representation of these arguments suitable for debugging purposes only.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DeleteArguments

        public DeleteArguments()
        Creates a new delete arguments object (deleteProjectContents is false).

      • DeleteArguments

        public DeleteArguments​(boolean deleteProjectContents)
        Creates a new delete arguments object.
        Parameters:
        deleteProjectContents - true if project contents will be deleted
        Since:
        3.6

    • Method Detail

      • getDeleteProjectContents

        public boolean getDeleteProjectContents()
        Returns whether project contents will be deleted as well. This method is not applicable for file and folder deletions.
        Returns:
        true if the refactoring will delete the project contents, false if it only removes the reference from the workspace
        Since:
        3.6

      • toString

        public java.lang.String toString()
        Returns a string representation of these arguments suitable for debugging purposes only.

        Subclasses should reimplement this method.

        Overrides:
        toString in class RefactoringArguments
        Returns:
        a debug string
        Since:
        3.2