org.netbeans.api.java.source

Class CodeStyleUtils

java.lang.Object

org.netbeans.api.java.source.CodeStyleUtils

public final class CodeStyleUtils
extends Object

Since:

0.123

Method Summary

Modifier and Type	Method and Description
static String	addPrefixSuffix(CharSequence name, String prefix, String suffix) Add a prefix and suffix to a name.
static String	computeGetterName(CharSequence fieldName, boolean isBoolean, boolean isStatic, CodeStyle cs) Computes the method name that should be used to read the property value.
static String	computeSetterName(CharSequence fieldName, boolean isStatic, CodeStyle cs) Computes the method name that should be used to write the property value.
static String	getCapitalizedName(CharSequence name) Capitalize a name following the javabeans specification.
static String	getDecapitalizedName(CharSequence name) Decapitalize a name to its normal java form.
static String	removePrefixSuffix(CharSequence name, String prefix, String suffix) Removes a prefix and suffix from a name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addPrefixSuffix

@NonNull
public static String addPrefixSuffix(@NullAllowed
                                              CharSequence name,
                                              @NullAllowed
                                              String prefix,
                                              @NullAllowed
                                              String suffix)

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".

Parameters:

name - the name to add the Prefix and Suffix to.

prefix - the prefix to add, or null if no prefix should be added.

suffix - the suffix to add, or null if no suffix should be added.

Returns:

the name with added prefix and suffix

See Also:

getCapitalizedName(java.lang.CharSequence)

removePrefixSuffix

@NonNull
public static String removePrefixSuffix(@NonNull
                                                 CharSequence name,
                                                 @NullAllowed
                                                 String prefix,
                                                 @NullAllowed
                                                 String suffix)

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.

Parameters:

name - the name to remove the Prefix and Suffix from.

prefix - the prefix to remove, or null if no prefix should be removed.

suffix - the suffix to remove, or null if no suffix should be removed.

Returns:

the name without the prefix and suffix

See Also:

addPrefixSuffix(java.lang.CharSequence, java.lang.String, java.lang.String), getDecapitalizedName(java.lang.CharSequence)

getCapitalizedName

@NonNull
public static String getCapitalizedName(CharSequence name)

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".

To stay backwards compatible, if the name starts with _ they will be removed.

Parameters:

name - the name to capitalize

Returns:

the capizalized name

getDecapitalizedName

@NonNull
public static String getDecapitalizedName(@NonNull
                                                   CharSequence name)

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".

Parameters:

name - the name to decapitalize

Returns:

the decapizalized name

computeGetterName

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

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

Parameters:

fieldName - the name of the property

isBoolean - true if the property is of boolean type

isStatic - true if the property is static

cs - the CodeSyle to use

Returns:

the getter name

computeSetterName

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

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

Parameters:

fieldName - the name of the property

isStatic - true if the property is static

cs - the CodeSyle to use

Returns:

the setter name