<change id="CodeStyle-Naming">

             <api name="general"/>

             <summary>Added <code>CodeStyleUtils</code>.</summary>

             <version major="0" minor="122"/>

             <date day="29" month="4" year="2013"/>

             <author login="ralphbenjamin"/>

             <compatibility addition="yes" binary="compatible" deletion="no" deprecation="no" modification="no" semantic="compatible" source="compatible"/>

             <description>

                 Added class <code>CodeStyleUtils</code>, which helps with

                 conforming java names to the naming codestyle. Used for

                 variable naming and getter/setter names.

             </description>

             <class package="org.netbeans.api.java.source" name="CodeStyleUtils"/>

             <issue number="228870"/>

        </change>

/*

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

 *

 * Copyright 2013 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 2013 Sun Microsystems, Inc.

 */

package org.netbeans.api.java.source;

import org.netbeans.api.annotations.common.NonNull;

import org.netbeans.api.annotations.common.NullAllowed;

import org.netbeans.lib.editor.util.CharSequenceUtilities;

/**

 *

 * @author Ralph Benjamin Ruijs <ralphbenjamin@netbeans.org>

 * @since 0.122

 */

public final class CodeStyleUtils {

    private CodeStyleUtils() {

    }

    /**

     * Add a prefix and suffix to a name. If the prefix or suffix are null, then

     * the name without prefixes or suffixes will be returned. When you add a

     * prefix value ending with an alphabetic character, the name will be

     * capitalized. For example, if the prefix for a name is defined as s, and

     * the name is "i", then the suggested name will be "sI".

     *

     *

     * @param name the name to add the Prefix and Suffix to.

     * @param prefix the prefix to add, or null if no prefix should be added.

     * @param suffix the suffix to add, or null if no suffix should be added.

     * @return the name with added prefix and suffix

     * @see #getCapitalizedName(java.lang.CharSequence)

     */

    @NonNull

    public static String addPrefixSuffix(@NullAllowed CharSequence name,

                                         @NullAllowed String prefix,

                                         @NullAllowed String suffix) {

        StringBuilder sb = new StringBuilder();

        boolean capitalize = false;

        if (prefix != null && prefix.length() > 0) {

            if (Character.isAlphabetic(prefix.charAt(prefix.length() - 1))) {

                capitalize = true;

            }

            sb.insert(0, prefix);

        }

        if (name != null) {

            sb.append(capitalize ? getCapitalizedName(name) : name);

        }

        if (suffix != null) {

            sb.append(suffix);

        }

        return sb.toString();

    }

    /**

     * Removes a prefix and suffix from a name. When you remove a prefix value

     * ending with an alphabetic character, the name will be decapitalized. If

     * the name originally started with _ , they will not be added.

     *

     * @param name the name to remove the Prefix and Suffix from.

     * @param prefix the prefix to remove, or null if no prefix should be

     * removed.

     * @param suffix the suffix to remove, or null if no suffix should be

     * removed.

     * @return the name without the prefix and suffix

     * @see #addPrefixSuffix(java.lang.CharSequence, java.lang.String,

     * java.lang.String)

     * @see #getDecapitalizedName(java.lang.CharSequence) 

     */

    @NonNull

    public static String removePrefixSuffix(@NonNull CharSequence name,

                                            @NullAllowed String prefix,

                                            @NullAllowed String suffix) {

        StringBuilder sb = new StringBuilder(name);

        int start = 0;

        int end = name.length();

        boolean decapitalize = false;

        if (prefix != null && CharSequenceUtilities.startsWith(name, prefix)) {

            start = prefix.length();

            if (Character.isAlphabetic(prefix.charAt(prefix.length() - 1))) {

                decapitalize = true;

            }

        }

        if (suffix != null && CharSequenceUtilities.endsWith(name, suffix)) {

            end = end - suffix.length();

        }

        String result = sb.substring(start, end);

        if(decapitalize) {

            return getDecapitalizedName(result);

        } else {

            return result;

        }

    }

    /**

     * Capitalize a name following the javabeans specification. This normally

     * means converting the first character from lower case to upper case, but

     * in the (unusual) special case when there is more than one character and

     * the second character is upper case, we leave it alone. Thus "fooBah"

     * becomes "FooBah" and "x" becomes "X", but "eMail" stays as "eMail".

     * <p>To stay backwards compatible, if the name starts with _ they will be

     * removed.

     *

     * @param name the name to capitalize

     * @return the capizalized name

     */

    @NonNull

    public static String getCapitalizedName(CharSequence name) {

        StringBuilder sb = new StringBuilder(name);

        while (sb.length() > 1 && sb.charAt(0) == '_') { //NOI18N

            sb.deleteCharAt(0);

        }

        //Beans naming convention, #165241

        if (sb.length() > 1 && Character.isUpperCase(sb.charAt(1))) {

            return sb.toString();

        }

        if (sb.length() > 0) {

            sb.setCharAt(0, Character.toUpperCase(sb.charAt(0)));

        }

        return sb.toString();

    }

    /**

     * Decapitalize a name to its normal java form. This normally

     * means converting the first character from upper case to lower case, but

     * in the (unusual) special case when there is more than one character and

     * the second character is upper case, we leave it alone. Thus "FooBah"

     * becomes "fooBah" and "X" becomes "x", but "URL" stays as "URL".

     *

     * @param name the name to decapitalize

     * @return the decapizalized name

     */

    @NonNull

    public static String getDecapitalizedName(@NonNull CharSequence name) {

        //Beans naming convention, #165241

        if (name.length() > 1 && (Character.isUpperCase(name.charAt(1)) ||

                                  Character.isLowerCase(name.charAt(0)))) {

            return name.toString();

        }

        StringBuilder sb = new StringBuilder(name);

        if (sb.length() > 0) {

            sb.setCharAt(0, Character.toLowerCase(sb.charAt(0)));

        }

        return sb.toString();

    }

    /**

     * Computes the method name that should be used to read the property value.

     * 

     * @param fieldName the name of the property

     * @param isBoolean true if the property is of boolean type

     * @param isStatic true if the property is static

     * @param cs the CodeSyle to use

     * @return the getter name

     */

    @NonNull

    public static String computeGetterName(CharSequence fieldName, boolean isBoolean, boolean isStatic, CodeStyle cs) {

        StringBuilder sb = new StringBuilder(getCapitalizedName(removeFieldPrefixSuffix(fieldName, isStatic, cs)));

        sb.insert(0, isBoolean && cs.useIsForBooleanGetters() ? "is" : "get"); //NOI18N

        String getterName = sb.toString();

        return getterName;

    }

    /**

     * Computes the method name that should be used to write the property value.

     * 

     * @param fieldName the name of the property

     * @param isStatic true if the property is static

     * @param cs the CodeSyle to use

     * @return the setter name

     */

    @NonNull

    public static String computeSetterName(CharSequence fieldName, boolean isStatic, CodeStyle cs) {

        StringBuilder name = new StringBuilder(getCapitalizedName(removeFieldPrefixSuffix(fieldName, isStatic, cs)));

        name.insert(0, "set"); //NOI18N

        return name.toString();

    }

    private static String removeFieldPrefixSuffix(CharSequence fieldName, boolean isStatic, CodeStyle cs) {

        return removePrefixSuffix(fieldName,

                                  isStatic ? cs.getStaticFieldNamePrefix() : cs.getFieldNamePrefix(),

                                  isStatic ? cs.getStaticFieldNameSuffix() : cs.getFieldNameSuffix());

    }

}

/*

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

 *

 * Copyright 2013 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 2013 Sun Microsystems, Inc.

 */

package org.netbeans.api.java.source;

import org.junit.Test;

import static org.junit.Assert.*;

/**

 *

 * @author Ralph Benjamin Ruijs <ralphbenjamin@netbeans.org>

 */

public class CodeStyleUtilsTest {

    @Test

    public void testAddPrefixSuffix() {

        CharSequence name = null;

        String prefix = null;

        String suffix = null;

        String result = CodeStyleUtils.addPrefixSuffix(name, prefix, suffix);

        assertEquals("", result);

        name = "name";

        result = CodeStyleUtils.addPrefixSuffix(name, prefix, suffix);

        assertEquals(name, result);

        suffix = "S";

        result = CodeStyleUtils.addPrefixSuffix(name, prefix, suffix);

        assertEquals("nameS", result);

        prefix = "$";

        result = CodeStyleUtils.addPrefixSuffix(name, prefix, suffix);

        assertEquals("$nameS", result);

        prefix = "s";

        result = CodeStyleUtils.addPrefixSuffix(name, prefix, suffix);

        assertEquals("sNameS", result);

        name = "__name";

        result = CodeStyleUtils.addPrefixSuffix(name, prefix, suffix);

        assertEquals("sNameS", result);

        name = null;

        result = CodeStyleUtils.addPrefixSuffix(name, prefix, suffix);

        assertEquals("sS", result);

    }

    @Test

    public void testRemovePrefixSuffix() {

        String prefix = null;

        String suffix = null;

        CharSequence name = "name";

        String result = CodeStyleUtils.removePrefixSuffix(name, prefix, suffix);

        assertEquals(name, result);

        suffix = "S";

        name = "nameS";

        result = CodeStyleUtils.removePrefixSuffix(name, prefix, suffix);

        assertEquals("name", result);

        prefix = "$";

        name = "$nameS";

        result = CodeStyleUtils.removePrefixSuffix(name, prefix, suffix);

        assertEquals("name", result);

        prefix = "s";

        name = "sNameS";

        result = CodeStyleUtils.removePrefixSuffix(name, prefix, suffix);

        assertEquals("name", result);

        prefix = "_";

        name = "__nameS";

        result = CodeStyleUtils.removePrefixSuffix(name, prefix, suffix);

        assertEquals("_name", result);

        prefix = "S";

        suffix = "s";

        name = "sNameS";

        result = CodeStyleUtils.removePrefixSuffix(name, prefix, suffix);

        assertEquals("sNameS", result);

    }

    @Test

    public void testGetCapitalizedName() {

        CharSequence name = "name";

        String result = CodeStyleUtils.getCapitalizedName(name);

        assertEquals("Name", result);

        name = "Name";

        result = CodeStyleUtils.getCapitalizedName(name);

        assertEquals("Name", result);

        name = "NAME";

        result = CodeStyleUtils.getCapitalizedName(name);

        assertEquals("NAME", result);

        name = "nAme";

        result = CodeStyleUtils.getCapitalizedName(name);

        assertEquals("nAme", result);

        name = "naMe";

        result = CodeStyleUtils.getCapitalizedName(name);

        assertEquals("NaMe", result);

    }

    @Test

    public void testGetDecapitalizedName() {

        CharSequence name = "name";

        String result = CodeStyleUtils.getDecapitalizedName(name);

        assertEquals("name", result);

        name = "Name";

        result = CodeStyleUtils.getDecapitalizedName(name);

        assertEquals("name", result);

        name = "NAME";

        result = CodeStyleUtils.getDecapitalizedName(name);

        assertEquals("NAME", result);

        name = "nAme";

        result = CodeStyleUtils.getDecapitalizedName(name);

        assertEquals("nAme", result);

        name = "NaMe";

        result = CodeStyleUtils.getDecapitalizedName(name);

        assertEquals("naMe", result);

    }

}