/*******************************************************************************
 * Copyright (c) 2000, 2007 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.ide.ext.java.jdt.internal.text.correction.proposals;

import org.eclipse.che.ide.ext.java.jdt.Images;
import org.eclipse.che.ide.ext.java.jdt.core.dom.IMethodBinding;
import org.eclipse.che.ide.ext.java.jdt.core.dom.MethodDeclaration;
import org.eclipse.che.ide.ext.java.jdt.core.dom.rewrite.ASTRewrite;
import org.eclipse.che.ide.ext.java.jdt.internal.corext.codemanipulation.StubUtility;
import org.eclipse.che.ide.ext.java.jdt.text.Document;
import org.eclipse.che.ide.runtime.CoreException;


/**
 * A proposal for quick fixes and quick assists that works on a AST rewriter and enters the
 * linked mode when the proposal is set up.
 * Either a rewriter is directly passed in the constructor or method {@link #getRewrite()} is overridden
 * to provide the AST rewriter that is evaluated to the document when the proposal is
 * applied.
 *
 * @since 3.0
 */
public class LinkedCorrectionProposal extends ASTRewriteCorrectionProposal {

    /**
     * Constructs a linked correction proposal.
     *
     * @param name
     *         The display name of the proposal.
     * @param cu
     *         The compilation unit that is modified.
     * @param rewrite
     *         The AST rewrite that is invoked when the proposal is applied
     *         <code>null</code> can be passed if {@link #getRewrite()} is overridden.
     * @param relevance
     *         The relevance of this proposal.
     * @param image
     *         The image that is displayed for this proposal or <code>null</code> if no
     *         image is desired.
     */
    public LinkedCorrectionProposal(String name, ASTRewrite rewrite, int relevance, Document document, Images image) {
        super(name, rewrite, relevance, document, image);
    }

    public static String getMethodComment(String declaringTypeName, MethodDeclaration decl, IMethodBinding overridden,
                                          String lineDelimiter) throws CoreException {
        if (overridden != null) {
            overridden = overridden.getMethodDeclaration();
            String declaringClassQualifiedName = overridden.getDeclaringClass().getQualifiedName();
            String linkToMethodName = overridden.getName();
            String[] parameterTypesQualifiedNames = StubUtility.getParameterTypeNamesForSeeTag(overridden);
            return StubUtility.getMethodComment(declaringTypeName, decl, overridden.isDeprecated(), linkToMethodName,
                                                declaringClassQualifiedName, parameterTypesQualifiedNames, false, lineDelimiter);
        } else {
            return StubUtility.getMethodComment(declaringTypeName, decl, false, null, null, null, false, lineDelimiter);
        }
    }

    //	/**
    //	 * Adds a linked position to be shown when the proposal is applied. All position with the
    //	 * same group id are linked.
    //	 * @param position The position to add.
    //	 * @param isFirst If set, the proposal is jumped to first.
    //	 * @param groupID The id of the group the proposal belongs to. All proposals in the same group
    //	 * are linked.
    //	 */
    //	public void addLinkedPosition(ITrackedNodePosition position, boolean isFirst, String groupID) {
    //		getLinkedProposalModel().getPositionGroup(groupID, true).addPosition(position, isFirst);
    //	}
    //
    //	/**
    //	 * Sets the end position of the linked mode to the end of the passed range.
    //	 * @param position The position that describes the end position of the linked mode.
    //	 */
    //	public void setEndPosition(ITrackedNodePosition position) {
    //		getLinkedProposalModel().setEndPosition(position);
    //	}

    //	/**
    //	 * Adds a linked position proposal to the group with the given id.
    //	 * @param groupID The id of the group that should present the proposal
    //	 * @param proposal The string to propose.
    //	 * @param image The image to show for the position proposal or <code>null</code> if
    //	 * no image is desired.
    //	 */
    //	public void addLinkedPositionProposal(String groupID, String proposal, Image image) {
    //		getLinkedProposalModel().getPositionGroup(groupID, true).addProposal(proposal, image, 10);
    //	}

    //	/**
    //	 * Adds a linked position proposal to the group with the given id.
    //	 * @param groupID The id of the group that should present the proposal
    //	 * 	@param displayString The name of the proposal
    //	 * @param proposal The string to insert.
    //	 * @param image The image to show for the position proposal or <code>null</code> if
    //	 * no image is desired.
    //	 * @deprecated use {@link #addLinkedPositionProposal(String, String, Image)} instead
    //	 */
    //	public void addLinkedPositionProposal(String groupID, String displayString, String proposal, Image image) {
    //		addLinkedPositionProposal(groupID, proposal, image);
    //	}
    //
    //	/**
    //	 * Adds a linked position proposal to the group with the given id.
    //	 * @param groupID The id of the group that should present the proposal
    //	 * @param type The binding to use as type name proposal.
    //	 */
    //	public void addLinkedPositionProposal(String groupID, ITypeBinding type) {
    //		getLinkedProposalModel().getPositionGroup(groupID, true).addProposal(type, getCompilationUnit(), 10);
    //	}
}