Class OverrideMethodsAction

  • All Implemented Interfaces:
    IAction, ISelectionChangedListener

    public class OverrideMethodsAction
    extends SelectionDispatchAction
    Adds unimplemented methods of a type. The action opens a dialog from which the user can choose the methods to be added.

    Will open the parent compilation unit in a Java editor. The result is unsaved, so the user can decide if the changes are acceptable.

    The action is applicable to structured selections containing elements of type IType.

    This class may be instantiated; it is not intended to be subclassed.

    Since:
    2.0
    Restriction:
    This class is not intended to be subclassed by clients.
    • Constructor Detail

      • OverrideMethodsAction

        public OverrideMethodsAction​(org.eclipse.jdt.internal.ui.javaeditor.CompilationUnitEditor editor)
        Note: This constructor is for internal use only. Clients should not call this constructor.
        Parameters:
        editor - the compilation unit editor
        Restriction:
        This constructor is not intended to be referenced by clients.
      • OverrideMethodsAction

        public OverrideMethodsAction​(IWorkbenchSite site)
        Creates a new override method action.

        The action requires that the selection provided by the site's selection provider is of type IStructuredSelection.

        Parameters:
        site - the workbench site providing context information for this action
    • Method Detail

      • createRunnable

        public static IWorkspaceRunnable createRunnable​(CompilationUnit astRoot,
                                                        ITypeBinding type,
                                                        IMethodBinding[] methodToOverride,
                                                        int insertPos,
                                                        boolean createComments)
        Returns a runnable that creates the method stubs for overridden methods.
        Parameters:
        astRoot - the AST of the compilation unit to work on. The AST must have been created from a ICompilationUnit, that means ASTParser.setSource(ICompilationUnit) was used.
        type - the binding of the type to add the new methods to. The type binding must correspond to a type declaration in the AST.
        methodToOverride - the bindings of methods to override or null to implement all unimplemented, abstract methods from super types.
        insertPos - a hint for a location in the source where to insert the new methods or -1 to use the default behavior.
        createComments - if set, comments will be added to the new methods.
        Returns:
        returns a runnable that creates the methods stubs.
        Throws:
        IllegalArgumentException - a IllegalArgumentException is thrown if the AST passed has not been created from a ICompilationUnit.
        Since:
        3.2