com.haulmont.cuba.core.config

Class ConfigUtil

java.lang.Object

com.haulmont.cuba.core.config.ConfigUtil

public final class ConfigUtil
extends java.lang.Object

Various configuration utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NO_DEFAULT The value indicating that no default was specified.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	extendedUncapitalize(java.lang.String str) Uncapitalize a string with support for leading acronyms.
static <T extends java.lang.annotation.Annotation> T	getAnnotation(java.lang.Class<?> configInterface, java.lang.reflect.Method method, java.lang.Class<T> annotationType, boolean searchMethodType) Search for an annotation on a configuration interface method.
static java.lang.String	getDefaultValue(java.lang.Class<?> configInterface, java.lang.reflect.Method method) Get the default value of a configuration interface method.
static java.lang.Class<?>	getEnumIdType(java.lang.Class<? extends EnumClass> enumeration) Returns id type parameter for classes that implement EnumClass.
static java.lang.reflect.Method	getGetMethod(java.lang.Class<?> configInterface, java.lang.reflect.Method method) Get the plain get method associated with a configuration interface method.
static java.lang.Class<?>	getMethodType(java.lang.reflect.Method method) Get the type of a method.
static java.lang.String	getPropertyName(java.lang.Class<?> configInterface, java.lang.reflect.Method method) Get the property name associated with a configuration interface method.
static java.lang.String	getPropertyPrefix(java.lang.Class<?> configInterface) Get the prefix associated with a configuration interface.
static SourceType	getSourceType(java.lang.Class<?> configInterface, java.lang.reflect.Method method)

Methods inherited from class java.lang.Object

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

Field Detail

NO_DEFAULT

public static final java.lang.String NO_DEFAULT

The value indicating that no default was specified.

Method Detail

extendedUncapitalize

public static java.lang.String extendedUncapitalize(java.lang.String str)

Uncapitalize a string with support for leading acronyms. This supports pretty uncapitalization of strings such as "URL" (to "url") and "URLDecoder" (to "urlDecoder"). If a string begins with a sequence of capital letters, all but the last are uncapitalized, except in the case that the entire string is capitalized or the capitals are followed by a non-letter, in which case all are uncapitalized.

Parameters:

str - The string.

Returns:

The uncapitalized string.

getPropertyName

public static java.lang.String getPropertyName(java.lang.Class<?> configInterface,
                                               java.lang.reflect.Method method)

Get the property name associated with a configuration interface method. If a Property annotation is present, that value is returned. Otherwise the interface prefix is concatenated with the uncapitalized property name.

Parameters:

configInterface - The configuration interface.

method - The method.

Returns:

The property name.

getPropertyPrefix

public static java.lang.String getPropertyPrefix(java.lang.Class<?> configInterface)

Get the prefix associated with a configuration interface. If the interface has an enclosing class, the fully-qualified name of that class is used, or else the name of the package containing the interface. In either of the latter two cases, a '.' is appended to the name.

Parameters:

configInterface - The configuration interface.

Returns:

The interface prefix.

getMethodType

public static java.lang.Class<?> getMethodType(java.lang.reflect.Method method)

Get the type of a method. If the method has a non-void return type, that type is returned. Otherwise if the method has at least one parameter, the type of the first parameter is returned.

Parameters:

method - The method.

Returns:

The method type, or else Void.TYPE.

getGetMethod

public static java.lang.reflect.Method getGetMethod(java.lang.Class<?> configInterface,
                                                    java.lang.reflect.Method method)

Get the plain get method associated with a configuration interface method. This is the unparameterized getter associated with the same field as the specified configuration method. For example, isDisabled() might be returned for the method addDisabledListener().

Parameters:

configInterface - The configuration interface.

method - The method.

Returns:

The plain get method, or else null.

getAnnotation

public static <T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.Class<?> configInterface,
                                                                          java.lang.reflect.Method method,
                                                                          java.lang.Class<T> annotationType,
                                                                          boolean searchMethodType)

Search for an annotation on a configuration interface method. In addition to searching the method itself, the plain get method is also searched, as can the method type be.

Parameters:

configInterface - The configuration interface.

method - The method.

annotationType - The annotation type of interest.

searchMethodType - Whether to search the method type.

Returns:

The annotation, or null.

getDefaultValue

public static java.lang.String getDefaultValue(java.lang.Class<?> configInterface,
                                               java.lang.reflect.Method method)

Get the default value of a configuration interface method. If a Default annotation is present then that string is converted to the appropriate type using the TypeFactory class. Otherwise, for the type Foo, this searches for a FooDefault annotation. If such an annotation is present then its value is returned.

Parameters:

configInterface - The configuration interface.

method - The method.

Returns:

The default value, or null.

getSourceType

public static SourceType getSourceType(java.lang.Class<?> configInterface,
                                       java.lang.reflect.Method method)

getEnumIdType

public static java.lang.Class<?> getEnumIdType(java.lang.Class<? extends EnumClass> enumeration)

Returns id type parameter for classes that implement EnumClass. Id type is usually known for concrete enum classes, but if type is unavailable, IllegalArgumentException is thrown.

Parameters:

enumeration - class describing subclass of EnumClass

Returns:

id type parameter