OnSaveCustomizer.removeUnusedImports.text=Remove Unused Imports

OnSaveCustomizer.organizeImports.text=Organize Imports

<?xml version="1.0" encoding="UTF-8" ?>

<Form version="1.5" maxVersion="1.8" type="org.netbeans.modules.form.forminfo.JPanelFormInfo">

  <AuxValues>

    <AuxValue name="FormSettings_autoResourcing" type="java.lang.Integer" value="1"/>

    <AuxValue name="FormSettings_autoSetComponentName" type="java.lang.Boolean" value="false"/>

    <AuxValue name="FormSettings_generateFQN" type="java.lang.Boolean" value="true"/>

    <AuxValue name="FormSettings_generateMnemonicsCode" type="java.lang.Boolean" value="true"/>

    <AuxValue name="FormSettings_i18nAutoMode" type="java.lang.Boolean" value="true"/>

    <AuxValue name="FormSettings_layoutCodeTarget" type="java.lang.Integer" value="1"/>

    <AuxValue name="FormSettings_listenerGenerationStyle" type="java.lang.Integer" value="0"/>

    <AuxValue name="FormSettings_variablesLocal" type="java.lang.Boolean" value="false"/>

    <AuxValue name="FormSettings_variablesModifier" type="java.lang.Integer" value="2"/>

  </AuxValues>

  <Layout>

    <DimensionLayout dim="0">

      <Group type="103" groupAlignment="0" attributes="0">

          <Group type="102" attributes="0">

              <EmptySpace max="-2" attributes="0"/>

              <Group type="103" groupAlignment="0" attributes="0">

                  <Component id="removeUnusedImports" alignment="0" min="-2" max="-2" attributes="0"/>

                  <Component id="organizeImports" alignment="0" min="-2" max="-2" attributes="0"/>

              </Group>

              <EmptySpace pref="196" max="32767" attributes="0"/>

          </Group>

      </Group>

    </DimensionLayout>

    <DimensionLayout dim="1">

      <Group type="103" groupAlignment="0" attributes="0">

          <Group type="102" alignment="0" attributes="0">

              <EmptySpace max="-2" attributes="0"/>

              <Component id="removeUnusedImports" min="-2" max="-2" attributes="0"/>

              <EmptySpace type="unrelated" max="-2" attributes="0"/>

              <Component id="organizeImports" min="-2" max="-2" attributes="0"/>

              <EmptySpace pref="242" max="32767" attributes="0"/>

          </Group>

      </Group>

    </DimensionLayout>

  </Layout>

  <SubComponents>

    <Component class="javax.swing.JCheckBox" name="removeUnusedImports">

      <Properties>

        <Property name="text" type="java.lang.String" editor="org.netbeans.modules.i18n.form.FormI18nStringEditor">

          <ResourceString bundle="org/netbeans/modules/java/hints/onsave/Bundle.properties" key="OnSaveCustomizer.removeUnusedImports.text" replaceFormat="org.openide.util.NbBundle.getMessage({sourceFileName}.class, &quot;{key}&quot;)"/>

        </Property>

      </Properties>

      <Events>

        <EventHandler event="actionPerformed" listener="java.awt.event.ActionListener" parameters="java.awt.event.ActionEvent" handler="removeUnusedImportsActionPerformed"/>

      </Events>

    </Component>

    <Component class="javax.swing.JCheckBox" name="organizeImports">

      <Properties>

        <Property name="text" type="java.lang.String" editor="org.netbeans.modules.i18n.form.FormI18nStringEditor">

          <ResourceString bundle="org/netbeans/modules/java/hints/onsave/Bundle.properties" key="OnSaveCustomizer.organizeImports.text" replaceFormat="org.openide.util.NbBundle.getMessage({sourceFileName}.class, &quot;{key}&quot;)"/>

        </Property>

      </Properties>

      <Events>

        <EventHandler event="actionPerformed" listener="java.awt.event.ActionListener" parameters="java.awt.event.ActionEvent" handler="organizeImportsActionPerformed"/>

      </Events>

    </Component>

  </SubComponents>

</Form>

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2012 Sun Microsystems, Inc.

 */

package org.netbeans.modules.java.hints.onsave;

import java.util.prefs.Preferences;

/**

 *

 * @author lahvac

 */

public class OnSaveCustomizer extends javax.swing.JPanel {

    private final Preferences settings;

    /**

     * Creates new form OnSaveCustomizer

     */

    public OnSaveCustomizer(Preferences settings) {

        initComponents();

        this.settings = settings;

        removeUnusedImports.setSelected(RemoveUnusedAfterSave.getValue(settings, "Imports_UNUSED"));

        organizeImports.setSelected(RemoveUnusedAfterSave.getValue(settings, "org.netbeans.modules.java.hints.OrganizeImports"));

    }

    /**

     * This method is called from within the constructor to initialize the form.

     * WARNING: Do NOT modify this code. The content of this method is always

     * regenerated by the Form Editor.

     */

    @SuppressWarnings("unchecked")

    // <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents

    private void initComponents() {

        removeUnusedImports = new javax.swing.JCheckBox();

        organizeImports = new javax.swing.JCheckBox();

        org.openide.awt.Mnemonics.setLocalizedText(removeUnusedImports, org.openide.util.NbBundle.getMessage(OnSaveCustomizer.class, "OnSaveCustomizer.removeUnusedImports.text")); // NOI18N

        removeUnusedImports.addActionListener(new java.awt.event.ActionListener() {

            public void actionPerformed(java.awt.event.ActionEvent evt) {

                removeUnusedImportsActionPerformed(evt);

            }

        });

        org.openide.awt.Mnemonics.setLocalizedText(organizeImports, org.openide.util.NbBundle.getMessage(OnSaveCustomizer.class, "OnSaveCustomizer.organizeImports.text")); // NOI18N

        organizeImports.addActionListener(new java.awt.event.ActionListener() {

            public void actionPerformed(java.awt.event.ActionEvent evt) {

                organizeImportsActionPerformed(evt);

            }

        });

        javax.swing.GroupLayout layout = new javax.swing.GroupLayout(this);

        this.setLayout(layout);

        layout.setHorizontalGroup(

            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)

            .addGroup(layout.createSequentialGroup()

                .addContainerGap()

                .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)

                    .addComponent(removeUnusedImports)

                    .addComponent(organizeImports))

                .addContainerGap(196, Short.MAX_VALUE))

        );

        layout.setVerticalGroup(

            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)

            .addGroup(layout.createSequentialGroup()

                .addContainerGap()

                .addComponent(removeUnusedImports)

                .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.UNRELATED)

                .addComponent(organizeImports)

                .addContainerGap(242, Short.MAX_VALUE))

        );

    }// </editor-fold>//GEN-END:initComponents

    private void removeUnusedImportsActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_removeUnusedImportsActionPerformed

        settings.putBoolean(RemoveUnusedAfterSave.KEY_SETTINGS_PREFIX + "Imports_UNUSED", removeUnusedImports.isSelected());

    }//GEN-LAST:event_removeUnusedImportsActionPerformed

    private void organizeImportsActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_organizeImportsActionPerformed

        settings.putBoolean(RemoveUnusedAfterSave.KEY_SETTINGS_PREFIX + "org.netbeans.modules.java.hints.OrganizeImports", organizeImports.isSelected());

    }//GEN-LAST:event_organizeImportsActionPerformed

    // Variables declaration - do not modify//GEN-BEGIN:variables

    private javax.swing.JCheckBox organizeImports;

    private javax.swing.JCheckBox removeUnusedImports;

    // End of variables declaration//GEN-END:variables

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2012 Sun Microsystems, Inc.

 */

package org.netbeans.modules.java.hints.onsave;

import java.util.prefs.Preferences;

import javax.swing.JComponent;

import org.netbeans.modules.options.editor.spi.PreferencesCustomizer;

import org.openide.util.HelpCtx;

/**

 *

 * @author lahvac

 */

public class OnSavePreferencesCustomizer implements PreferencesCustomizer {

    private final Preferences preferences;

    public OnSavePreferencesCustomizer(Preferences preferences) {

        this.preferences = preferences;

    }

    @Override

    public String getId() {

        return "java-hints-on-save";

    }

    @Override

    public String getDisplayName() {

        return "Java";

    }

    @Override

    public HelpCtx getHelpCtx() {

        return null;

    }

    @Override

    public JComponent getComponent() {

        return new OnSaveCustomizer(preferences);

    }

    public static final class FactoryImpl implements Factory {

        @Override

        public PreferencesCustomizer create(Preferences preferences) {

            return new OnSavePreferencesCustomizer(preferences);

        }

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2012 Sun Microsystems, Inc.

 */

package org.netbeans.modules.java.hints.onsave;

import java.io.IOException;

import java.util.ArrayList;

import java.util.Collection;

import java.util.HashMap;

import java.util.HashSet;

import java.util.List;

import java.util.Map;

import java.util.Map.Entry;

import java.util.Set;

import java.util.concurrent.atomic.AtomicBoolean;

import java.util.prefs.Preferences;

import javax.swing.undo.UndoableEdit;

import org.netbeans.api.editor.mimelookup.MimeLookup;

import org.netbeans.api.editor.mimelookup.MimePath;

import org.netbeans.api.editor.mimelookup.MimeRegistration;

import org.netbeans.api.java.source.CompilationController;

import org.netbeans.api.java.source.JavaSource;

import org.netbeans.api.java.source.ModificationResult;

import org.netbeans.api.java.source.Task;

import org.netbeans.modules.java.hints.providers.spi.HintDescription;

import org.netbeans.modules.java.hints.providers.spi.HintMetadata;

import org.netbeans.modules.java.hints.spiimpl.MessageImpl;

import org.netbeans.modules.java.hints.spiimpl.RulesManager;

import org.netbeans.modules.java.hints.spiimpl.batch.BatchSearch;

import org.netbeans.modules.java.hints.spiimpl.batch.BatchSearch.BatchResult;

import org.netbeans.modules.java.hints.spiimpl.batch.BatchSearch.Folder;

import org.netbeans.modules.java.hints.spiimpl.batch.BatchUtilities;

import org.netbeans.modules.java.hints.spiimpl.batch.ProgressHandleWrapper;

import org.netbeans.modules.java.hints.spiimpl.batch.Scopes;

import org.netbeans.modules.refactoring.spi.RefactoringElementImplementation;

import org.netbeans.spi.editor.document.OnSaveTask;

import org.openide.filesystems.FileObject;

import org.openide.util.Exceptions;

/**

 *

 * @author lahvac

 */

public class RemoveUnusedAfterSave implements OnSaveTask {

    public static final String KEY_SETTINGS_PREFIX = "on-save.";

    private final Context c;

    private final JavaSource javaSource;

    private final Set<String> toRun;

    private final AtomicBoolean cancel = new AtomicBoolean();

    public RemoveUnusedAfterSave(Context c, JavaSource javaSource, Set<String> toRun) {

        this.c = c;

        this.javaSource = javaSource;

        this.toRun = toRun;

    }

    @Override

    public void performTask(UndoableEdit undoEdit) {

        try {

            List<HintDescription> hints = new ArrayList<HintDescription>();

            for (Entry<HintMetadata, ? extends Collection<? extends HintDescription>> e : RulesManager.getInstance().readHints(null, null, cancel).entrySet()) {

                if (toRun.contains(e.getKey().id)) {

                    hints.addAll(e.getValue());

                }

            }

            FileObject file = javaSource.getFileObjects().iterator().next();

            BatchResult batchResult = BatchSearch.findOccurrences(hints, Scopes.specifiedFoldersScope(Folder.convert(file)));

            for (ModificationResult mr : BatchUtilities.applyFixes(batchResult, new ProgressHandleWrapper(1), cancel, new ArrayList<RefactoringElementImplementation>(), null, true, new ArrayList<MessageImpl>())) {

                mr.commit();

            }

        } catch (IOException ex) {

            Exceptions.printStackTrace(ex);

        }

    }

    @Override

    public void runLocked(final Runnable run) {

        try {

            javaSource.runUserActionTask(new Task<CompilationController>() {

                @Override public void run(CompilationController parameter) throws Exception {

                    run.run();

                }

            }, true);

        } catch (IOException ex) {

            throw new IllegalStateException(ex);

        }

    }

    @MimeRegistration(mimeType="text/x-java", service=Factory.class)

    public static class TaskFactory implements Factory {

        @Override public OnSaveTask createTask(Context context) {

            JavaSource javaSource = JavaSource.forDocument(context.getDocument());

            if (javaSource == null) return NOOP;

            Set<String> toRun = new HashSet<String>();

            Preferences settings = MimeLookup.getLookup(MimePath.get("text/x-java")).lookup(Preferences.class);

            for (Entry<String, Boolean> e : id2DefaultState.entrySet()) {

                if (settings.getBoolean(KEY_SETTINGS_PREFIX + e.getKey(), e.getValue())) toRun.add(e.getKey());

            }

            if (toRun.isEmpty()) return NOOP;

            return new RemoveUnusedAfterSave(context, javaSource, toRun);

        }

    }

    private static final Map<String, Boolean> id2DefaultState = new HashMap<String, Boolean>();

    static {

        id2DefaultState.put("Imports_UNUSED", false);

        id2DefaultState.put("org.netbeans.modules.java.hints.OrganizeImports", false);

    }

    static boolean getValue(Preferences settings, String id) {

        return settings.getBoolean(KEY_SETTINGS_PREFIX + id, id2DefaultState.get(id));

    }

    private static final OnSaveTask NOOP = new OnSaveTask() {

        @Override public void performTask(UndoableEdit undoEdit) { }

        @Override public void runLocked(Runnable run) {

            run.run();

        }

    };

}

        return applyFixes(candidates, progress, cancel, fileChanges, changesPerFix, false, problems);

    }

    public static Collection<ModificationResult> applyFixes(BatchResult candidates, @NonNull final ProgressHandleWrapper progress, AtomicBoolean cancel, final Collection<? super RefactoringElementImplementation> fileChanges, final Map<JavaFix, ModificationResult> changesPerFix, boolean doNotRegisterClassPath, final Collection<? super MessageImpl> problems) {