UserPreferencePage.java

/*
 * Copyright 2014
 * 
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License. You may obtain a
 * copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package net.sf.guavaeclipse.preferences;

import static net.sf.guavaeclipse.preferences.CompareToCommentsType.EVERY_FIELD_COMMENT;
import static net.sf.guavaeclipse.preferences.CompareToCommentsType.NO_COMMENTS;
import static net.sf.guavaeclipse.preferences.CompareToCommentsType.ONLY_ONE_COMMENT;
import static net.sf.guavaeclipse.preferences.EqualsEqualityType.CLASS_EQUALITY;
import static net.sf.guavaeclipse.preferences.EqualsEqualityType.INSTANCEOF;
import static net.sf.guavaeclipse.preferences.FieldsGetterType.FIELDS;
import static net.sf.guavaeclipse.preferences.FieldsGetterType.GETTER;
import static net.sf.guavaeclipse.preferences.HashCodeStrategyType.ARRAYS_DEEP_HASH_CODE;
import static net.sf.guavaeclipse.preferences.HashCodeStrategyType.OBJECTS_HASH_CODE;
import static net.sf.guavaeclipse.preferences.HashCodeStrategyType.SMART_HASH_CODE;
import static net.sf.guavaeclipse.preferences.MethodGenerationStratergy.DONT_USE_SUPER;
import static net.sf.guavaeclipse.preferences.MethodGenerationStratergy.SMART_OPTION;
import static net.sf.guavaeclipse.preferences.MethodGenerationStratergy.USE_SUPER;

import org.eclipse.jface.preference.BooleanFieldEditor;
import org.eclipse.jface.preference.FieldEditorPreferencePage;
import org.eclipse.jface.preference.RadioGroupFieldEditor;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;

import net.sf.guavaeclipse.Activator;

public class UserPreferencePage extends FieldEditorPreferencePage implements
    IWorkbenchPreferencePage {

  public static final String SUPERCALL_STRATEGY_PREFERENCE = "guavaPreference"; //$NON-NLS-1$

  public static final String INSTANCEOF_CLASSEQUALS_PREFERENCE = "guavaEclipseEqualsPreference"; //$NON-NLS-1$

  public static final String FIELDS_GETTER_PREFERENCE = "guavaEclipseFieldsGetterPreference"; //$NON-NLS-1$

  public static final String HASH_CODE_STRATEGY_PREFERENCE = "guavaEclipsePlugin.HashCodeStrategy"; //$NON-NLS-1$

  public static final String HIDE_COMPARE_TO_PREFERENCE = "guavaEclipsePlugin.hideCompareTo"; //$NON-NLS-1$

  public static final String MORE_OBJECTS_PREFERENCE = "guavaEclipsePlugin.moreObjects"; //$NON-NLS-1$

  public static final String COMPARE_COMMENT_PREFERENCE = "guavaEclipsePlugin.compareToComments"; //$NON-NLS-1$
  
  public UserPreferencePage() {
    super(FieldEditorPreferencePage.GRID);
  }

  @Override
  public void createFieldEditors() {

    addField(new BooleanFieldEditor(MORE_OBJECTS_PREFERENCE,
        "Use MoreObjects in toString Method (requires guava 18.0)", getFieldEditorParent()));
    addField(new RadioGroupFieldEditor(SUPERCALL_STRATEGY_PREFERENCE, "super method behavior", 1,
        new String[][] {
            new String[] {"Use super class Methods (toString(), equals() and hashCode())",
                USE_SUPER.name()},
            new String[] {"Don't use super class Methods (toString(), equals() and hashCode())",
                DONT_USE_SUPER.name()},
            new String[] {
                "Use super class Methods (Only if superclass is not \"java.lang.Object\")",
                SMART_OPTION.name()}}, getFieldEditorParent(), true));
    addField(new RadioGroupFieldEditor(INSTANCEOF_CLASSEQUALS_PREFERENCE,
        "instanceOf or class equality in equals", 1, new String[][] {
            new String[] {"Use instanceof in equals()", INSTANCEOF.name()},
            new String[] {"use class equality", CLASS_EQUALITY.name()}}, getFieldEditorParent(),
        true));
    addField(new RadioGroupFieldEditor(FIELDS_GETTER_PREFERENCE,
        "use fields directly or use getter methods in equals and hashCode", 1, new String[][] {
            new String[] {"use fields", FIELDS.name()},
            new String[] {"use getter methods", GETTER.name()}}, getFieldEditorParent(), true));
    addField(new RadioGroupFieldEditor(HASH_CODE_STRATEGY_PREFERENCE,
        "Use java.util.Arrays.deep Utility Methods or com.google.common.base.Objects Methods", 1,
        new String[][] {
            new String[] {"use always com.google.common.base.Objects Utility Methods",
                OBJECTS_HASH_CODE.name()},
            new String[] {"use always java.util.Arrays.deep Utility Methods",
                ARRAYS_DEEP_HASH_CODE.name()},
            new String[] {"Use java.util.Arrays.deep Utility methods only when necessary",
                SMART_HASH_CODE.name()}}, getFieldEditorParent(), true));
    
    addField(new BooleanFieldEditor(HIDE_COMPARE_TO_PREFERENCE, "Hide the compareTo menu",
        getFieldEditorParent()));
    
    addField(new RadioGroupFieldEditor(COMPARE_COMMENT_PREFERENCE,
        "Kind of \"advice\" comments in compareTo method for non-comparable fields", 1,
        new String[][] {
            new String[] {"for every non-comparable field a seperate comment",
                EVERY_FIELD_COMMENT.name()},
            new String[] {"only one comment at beginning of method",
                ONLY_ONE_COMMENT.name()},
            new String[] {"no comments at all (not recommended)",
                NO_COMMENTS.name()}}, getFieldEditorParent(), true));
    

  }

  @Override
  public void init(IWorkbench iworkbench) {
    setPreferenceStore(Activator.getDefault().getPreferenceStore());
    setDescription("Method generation preferences");
  }

}