ControlStatementsCleanUp.java

/*******************************************************************************
 * Copyright (c) 2000, 2011 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.corext.fix;

import org.eclipse.che.ide.ext.java.jdt.core.dom.CompilationUnit;
import org.eclipse.che.ide.runtime.CoreException;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

public class ControlStatementsCleanUp extends AbstractCleanUp {

    public ControlStatementsCleanUp(Map<String, String> options) {
        super(options);
    }

    public ControlStatementsCleanUp() {
        super();
    }

    /** {@inheritDoc} */
    @Override
    public CleanUpRequirements getRequirements() {
        return new CleanUpRequirements(requireAST(), false, false, null);
    }

    private boolean requireAST() {
        boolean useBlocks = isEnabled(CleanUpConstants.CONTROL_STATEMENTS_USE_BLOCKS);

        if (!useBlocks)
            return false;

        return isEnabled(CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_ALWAYS)
               || isEnabled(CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_NEVER)
               || isEnabled(CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_NO_FOR_RETURN_AND_THROW);
    }

    /** {@inheritDoc} */
    @Override
    public ICleanUpFix createFix(CleanUpContext context) throws CoreException {
        CompilationUnit compilationUnit = context.getAST();
        if (compilationUnit == null)
            return null;

        boolean useBlocks = isEnabled(CleanUpConstants.CONTROL_STATEMENTS_USE_BLOCKS);
        if (!useBlocks)
            return null;

        return ControlStatementsFix.createCleanUp(compilationUnit,
                                                  isEnabled(CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_ALWAYS),
                                                  isEnabled(CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_NEVER),
                                                  isEnabled(CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_NO_FOR_RETURN_AND_THROW),
                                                  context.getDocument());
    }

    /** {@inheritDoc} */
    @Override
    public String[] getStepDescriptions() {
        List<String> result = new ArrayList<String>();
        if (isEnabled(CleanUpConstants.CONTROL_STATEMENTS_USE_BLOCKS)
            && isEnabled(CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_ALWAYS))
            result.add(MultiFixMessages.INSTANCE
                                       .CodeStyleMultiFix_ConvertSingleStatementInControlBodeyToBlock_description());
        if (isEnabled(CleanUpConstants.CONTROL_STATEMENTS_USE_BLOCKS)
            && isEnabled(CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_NEVER))
            result.add(MultiFixMessages.INSTANCE.ControlStatementsCleanUp_RemoveUnnecessaryBlocks_description());
        if (isEnabled(CleanUpConstants.CONTROL_STATEMENTS_USE_BLOCKS)
            && isEnabled(CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_NO_FOR_RETURN_AND_THROW))
            result.add(MultiFixMessages.INSTANCE
                                       .ControlStatementsCleanUp_RemoveUnnecessaryBlocksWithReturnOrThrow_description());

        return result.toArray(new String[result.size()]);
    }

    /** {@inheritDoc} */
    @Override
    public String getPreview() {
        StringBuffer buf = new StringBuffer();

        if (isEnabled(CleanUpConstants.CONTROL_STATEMENTS_USE_BLOCKS)
            && isEnabled(CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_ALWAYS)) {
            buf.append("if (obj == null) {\n"); //$NON-NLS-1$
            buf.append("    throw new IllegalArgumentException();\n"); //$NON-NLS-1$
            buf.append("}\n"); //$NON-NLS-1$

            buf.append("if (ids.length > 0) {\n"); //$NON-NLS-1$
            buf.append("    System.out.println(ids[0]);\n"); //$NON-NLS-1$
            buf.append("} else {\n"); //$NON-NLS-1$
            buf.append("    return;\n"); //$NON-NLS-1$
            buf.append("}\n"); //$NON-NLS-1$
        } else if (isEnabled(CleanUpConstants.CONTROL_STATEMENTS_USE_BLOCKS)
                   && isEnabled(CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_NEVER)) {
            buf.append("if (obj == null)\n"); //$NON-NLS-1$
            buf.append("    throw new IllegalArgumentException();\n"); //$NON-NLS-1$
            buf.append("\n"); //$NON-NLS-1$

            buf.append("if (ids.length > 0)\n"); //$NON-NLS-1$
            buf.append("    System.out.println(ids[0]);\n"); //$NON-NLS-1$
            buf.append("else\n"); //$NON-NLS-1$
            buf.append("    return;\n"); //$NON-NLS-1$
            buf.append("\n"); //$NON-NLS-1$
        } else if (isEnabled(CleanUpConstants.CONTROL_STATEMENTS_USE_BLOCKS)
                   && isEnabled(CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_NO_FOR_RETURN_AND_THROW)) {
            buf.append("if (obj == null)\n"); //$NON-NLS-1$
            buf.append("    throw new IllegalArgumentException();\n"); //$NON-NLS-1$
            buf.append("\n"); //$NON-NLS-1$

            buf.append("if (ids.length > 0) {\n"); //$NON-NLS-1$
            buf.append("    System.out.println(ids[0]);\n"); //$NON-NLS-1$
            buf.append("} else \n"); //$NON-NLS-1$
            buf.append("    return;\n"); //$NON-NLS-1$
            buf.append("\n"); //$NON-NLS-1$
        } else {
            buf.append("if (obj == null) {\n"); //$NON-NLS-1$
            buf.append("    throw new IllegalArgumentException();\n"); //$NON-NLS-1$
            buf.append("}\n"); //$NON-NLS-1$

            buf.append("if (ids.length > 0) {\n"); //$NON-NLS-1$
            buf.append("    System.out.println(ids[0]);\n"); //$NON-NLS-1$
            buf.append("} else \n"); //$NON-NLS-1$
            buf.append("    return;\n"); //$NON-NLS-1$
            buf.append("\n"); //$NON-NLS-1$
        }

        return buf.toString();
    }

}