info.magnolia.util

Class DeprecationUtil

java.lang.Object

info.magnolia.util.DeprecationUtil

public final class DeprecationUtil
extends Object

Provides convenience methods for processing Deprecated and MgnlDeprecated annotations.

Method Summary

Modifier and Type	Method and Description
static Optional<Class<?>>	findFirstEncounteredDeprecatedSuperType(Class<?> clazz) Searches for Deprecated super types of the given clazz.
static Collection<Method>	getDeprecatedReadMethods(TypeMapping mapping, Class<?> parentClass, String sourcePropertyName) Returns Deprecated methods from parentClass.
static String	getDeprecationMessage(Class<?> deprecatedClass) Returns human readable deprecation information for given deprecatedClass.
static String	getDeprecationMessage(Class<?> actualClass, Class<?> deprecatedParentClass) Returns human readable deprecation information for given actualClass and deprecatedParentClass.
static String	getDeprecationMessage(Method deprecatedMethod) Returns human readable deprecation information for given deprecatedMethod.
static String	getDeprecationMessage(String deprecatedType, String deprecatedTypeName, String since, String description) Returns human readable deprecation information.
static boolean	isDeprecated(AnnotatedElement element) Checks whether the given parameter element is Deprecated or not.

Methods inherited from class java.lang.Object

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

Method Detail

isDeprecated

public static boolean isDeprecated(AnnotatedElement element)

Checks whether the given parameter element is Deprecated or not.

findFirstEncounteredDeprecatedSuperType

public static Optional<Class<?>> findFirstEncounteredDeprecatedSuperType(Class<?> clazz)

Searches for Deprecated super types of the given clazz.

Returns the first encountered Deprecated Interface or Class (in favour of Interface). Returns Optional.EMPTY, if nothing found.

getDeprecatedReadMethods

public static Collection<Method> getDeprecatedReadMethods(TypeMapping mapping,
                                                          Class<?> parentClass,
                                                          String sourcePropertyName)

Returns Deprecated methods from parentClass.

Internally fetches class hierarchy of the given parentClass and iterates over them to find all deprecated methods. This is done because those methods could be deprecated in the super class/interface, however, not in the direct parentClass.

getDeprecationMessage

public static String getDeprecationMessage(Class<?> deprecatedClass)

Returns human readable deprecation information for given deprecatedClass.

getDeprecationMessage

public static String getDeprecationMessage(Class<?> actualClass,
                                           Class<?> deprecatedParentClass)

Returns human readable deprecation information for given actualClass and deprecatedParentClass.

getDeprecationMessage

public static String getDeprecationMessage(Method deprecatedMethod)

Returns human readable deprecation information for given deprecatedMethod.

getDeprecationMessage

public static String getDeprecationMessage(String deprecatedType,
                                           String deprecatedTypeName,
                                           String since,
                                           String description)

Returns human readable deprecation information.