com.github.misberner.apcommons.util

Class NameUtils

java.lang.Object

com.github.misberner.apcommons.util.NameUtils

public class NameUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
NameUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static String	accessorName(CharSequence userName, CharSequence userPrefix, CharSequence defaultPrefix, CharSequence fieldName) Resolves the name of an accessor method by following a certain set of rules.
static String	camelCase(CharSequence... components)
static String	capitalizeFirst(CharSequence str) Capitalizes the first character (if existent) in the given character sequence, and returns the result.
static String	firstDefinedName(CharSequence... charSeqs) Retrieves the first defined (i.e., non-empty and non-null) name in the given array, and returns it as a String.
static String[]	getCanonicalNames(Class<?>... classes)
static String[]	getCanonicalNames(Class<?> firstClass, Class<?>... otherClasses)
static String	getterName(CharSequence fieldName) Convenience method.
static String	getterName(CharSequence userName, CharSequence fieldName) Convenience method.
static String	getterName(CharSequence userName, CharSequence userPrefix, CharSequence fieldName) Convience method.
static boolean	isJavaIdentifier(CharSequence cs)
static boolean	isSimpleJavaIdentifier(CharSequence cs)
static boolean	isSimpleJavaIdentifierPart(char c)
static boolean	isSimpleJavaIdentifierStart(char c)
static boolean	isValidPackageName(CharSequence cs)
static boolean	isValidPackageReference(CharSequence cs)
static String	qualifiedName(CharSequence simpleName, CharSequence packageName) Qualifies a simple name, if applicable.
static String	resolvePackageName(CharSequence packageNameSpec, CharSequence referencePackage) Resolves a name of a package from a specification.
static String	setterName(CharSequence fieldName) Convenience method.
static String	setterName(CharSequence userName, CharSequence fieldName) Convenience method.
static String	setterName(CharSequence userName, CharSequence userPrefix, CharSequence fieldName) Convenience method.

Methods inherited from class java.lang.Object

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

Constructor Detail

NameUtils

public NameUtils()

Method Detail

qualifiedName

public static String qualifiedName(CharSequence simpleName,
                   CharSequence packageName)

Qualifies a simple name, if applicable. A package name which is null or which is empty is assumed to refer to the default package. Hence, the returned qualified name will equal the simple name in this case. Otherwise, the package name is prepended, followed by a dot ('.').

Parameters:

simpleName - the simple name

packageName - the package name, or null for the default package

Returns:

the qualified name

capitalizeFirst

public static String capitalizeFirst(CharSequence str)

Capitalizes the first character (if existent) in the given character sequence, and returns the result.

Parameters:

str - the character sequence

Returns:

a capitalized version of the specified character sequence

accessorName

public static String accessorName(CharSequence userName,
                  CharSequence userPrefix,
                  CharSequence defaultPrefix,
                  CharSequence fieldName)

Resolves the name of an accessor method by following a certain set of rules.

1. If userName is both non-null and non-empty, its value is used as the name.
2. Otherwise, the name consists of a prefix followed by fieldName. The first character of fieldName is capitalized if the prefix is non-empty. The prefix is determined as follows:
   1. If userPrefix is non-null, it is used as the prefix
   2. Otherwise, defaultPrefix is used as the prefix.

Parameters:

userName - the user-specified name, or null.

userPrefix - the user-specified prefix, or null.

defaultPrefix - the default prefix, or null.

fieldName - the name of the field

Returns:

the name of an accessor method for the specified field, as determined by the above-described rules.

getterName

public static String getterName(CharSequence userName,
                CharSequence userPrefix,
                CharSequence fieldName)

Convience method. Calling this method is equivalent to calling accessorName(userName, userPrefix, "get", fieldName)

getterName

public static String getterName(CharSequence userName,
                CharSequence fieldName)

Convenience method. Calling this method is equivalent to calling getterName(userName, null, fieldName)

getterName

public static String getterName(CharSequence fieldName)

Convenience method. Calling this method is equivalent to calling getterName(null, fieldName)

setterName

public static String setterName(CharSequence userName,
                CharSequence userPrefix,
                CharSequence fieldName)

Convenience method. Calling this method is equivalent to calling accessorName(userName, userPrefix, "set", fieldName)

setterName

public static String setterName(CharSequence userName,
                CharSequence fieldName)

Convenience method. Calling this method is equivalent to calling setterName(userName, null, fieldName)

setterName

public static String setterName(CharSequence fieldName)

Convenience method. Calling this method is equivalent to calling setterName(null, fieldName)

resolvePackageName

public static String resolvePackageName(CharSequence packageNameSpec,
                        CharSequence referencePackage)

Resolves a name of a package from a specification. A specification is either a fully-qualified package name (including "" for the empty package), or a relative specification beginning with a dot ('.'). In the latter case, the specification will be interpreted as relative to a given reference package name.

Usage examples:

• resolvePackageName(null, "com.example") returns "com.example"
• resolvePackageName("", "com.example") returns ""
• resolvePackageName("foo.bar", "com.example") returns "foo.bar"
• resolvePackageName(".", "com.example") returns "com.example"
• resolvePackageName(".foo.bar", "com.example") returns "com.example.foo.bar"

Parameters:

packageNameSpec - the specification of the package name, or null

referencePackage - the reference package name

Returns:

the resolved, fully-qualified package name.

firstDefinedName

public static String firstDefinedName(CharSequence... charSeqs)

Retrieves the first defined (i.e., non-empty and non-null) name in the given array, and returns it as a String.

Parameters:

charSeqs - the name array

Returns:

the first defined name as a String, or null if all provided names are undefined.

getCanonicalNames

public static String[] getCanonicalNames(Class<?>... classes)

Parameters:

classes -

Returns:

getCanonicalNames

public static String[] getCanonicalNames(Class<?> firstClass,
                         Class<?>... otherClasses)

isJavaIdentifier

public static boolean isJavaIdentifier(CharSequence cs)

isSimpleJavaIdentifierStart

public static boolean isSimpleJavaIdentifierStart(char c)

isSimpleJavaIdentifierPart

public static boolean isSimpleJavaIdentifierPart(char c)

isSimpleJavaIdentifier

public static boolean isSimpleJavaIdentifier(CharSequence cs)

isValidPackageName

public static boolean isValidPackageName(CharSequence cs)

isValidPackageReference

public static boolean isValidPackageReference(CharSequence cs)

camelCase

public static String camelCase(CharSequence... components)