org.jboss.weld.util.reflection

Class Formats

java.lang.Object

org.jboss.weld.util.reflection.Formats

public class Formats
extends java.lang.Object

Utility class to produce friendly names e.g. for debugging

Author:

Pete Muir, Nicklas Karlsson, Jozef Hartinger

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addSpaceIfNeeded(java.lang.String string)
static java.lang.String	formatActualTypeArguments(java.lang.reflect.Type type)
static java.lang.String	formatActualTypeArguments(java.lang.reflect.Type[] actualTypeArguments)
static java.lang.String	formatAnnotatedConstructor(AnnotatedConstructor<?> constructor)
static java.lang.String	formatAnnotatedField(AnnotatedField<?> field)
static java.lang.String	formatAnnotatedMethod(AnnotatedMethod<?> method)
static java.lang.String	formatAnnotatedParameter(AnnotatedParameter<?> parameter)
static java.lang.String	formatAnnotatedType(AnnotatedType<?> type)
static java.lang.String	formatAnnotations(java.lang.annotation.Annotation[] annotations) Gets a string representation from an array of annotations
static java.lang.String	formatAnnotations(java.lang.Iterable<java.lang.annotation.Annotation> annotations)
static java.lang.String	formatAsFormalParameterList(java.lang.Iterable<? extends AnnotatedParameter<?>> parameters)
static java.lang.String	formatAsStackTraceElement(InjectionPoint ij) See also WELD-1454.
static java.lang.String	formatAsStackTraceElement(java.lang.reflect.Member member)
static java.lang.String	formatBusinessInterfaceDescriptors(java.lang.Iterable<? extends BusinessInterfaceDescriptor<?>> businessInterfaceDescriptors)
static java.lang.String	formatInjectionPointType(java.lang.reflect.Type type)
static java.lang.String	formatModifiers(int modifiers)
static java.lang.String	formatParameter(AnnotatedParameter<?> parameter)
static java.lang.String	formatSimpleClassName(java.lang.Class<?> javaClass)
static java.lang.String	formatSimpleClassName(java.lang.Object object)
static java.lang.String	formatType(java.lang.reflect.Type baseType)
static java.lang.String	formatType(java.lang.reflect.Type baseType, boolean simpleNames)
static java.lang.String	formatTypes(java.lang.Iterable<? extends java.lang.reflect.Type> baseTypes)
static java.lang.String	formatTypes(java.lang.Iterable<? extends java.lang.reflect.Type> baseTypes, boolean simpleNames)
static int	getLineNumber(java.lang.reflect.Member member) Try to get the line number associated with the given member.
static java.lang.String	getNameOfMissingClassLoaderDependency(java.lang.Throwable e) Attempts to extract a name of a missing class loader dependency from an exception such as NoClassDefFoundError or ClassNotFoundException.
static java.lang.String	getSimpleVersion()
static java.lang.String	version(java.lang.Package pkg)
static java.lang.String	version(java.lang.String version, java.lang.String timestamp)
static java.lang.String	wrapIfNecessary(java.lang.String string, java.lang.String prepend, java.lang.String append)

Methods inherited from class java.lang.Object

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

Method Detail

formatAsStackTraceElement

public static java.lang.String formatAsStackTraceElement(InjectionPoint ij)

See also WELD-1454.

Parameters:

ij -

Returns:

the formatted string

formatAsStackTraceElement

public static java.lang.String formatAsStackTraceElement(java.lang.reflect.Member member)

getLineNumber

public static int getLineNumber(java.lang.reflect.Member member)

Try to get the line number associated with the given member. The reflection API does not expose such an info and so we need to analyse the bytecode. Unfortunately, it seems there is no way to get this kind of information for fields. Moreover, the LineNumberTable attribute is just optional, i.e. the compiler is not required to store this information at all. See also Java Virtual Machine Specification Implementation note: it wouldn't be appropriate to add a bytecode scanning dependency just for this functionality, therefore Apache BCEL included in Oracle JDK 1.5+ and OpenJDK 1.6+ is used. Other JVMs should not crash as we only use it if it's on the classpath and by means of reflection calls.

Parameters:

member -

resourceLoader -

Returns:

the line number or 0 if it's not possible to find it

formatInjectionPointType

public static java.lang.String formatInjectionPointType(java.lang.reflect.Type type)

formatType

public static java.lang.String formatType(java.lang.reflect.Type baseType)

formatType

public static java.lang.String formatType(java.lang.reflect.Type baseType,
                                          boolean simpleNames)

formatTypes

public static java.lang.String formatTypes(java.lang.Iterable<? extends java.lang.reflect.Type> baseTypes,
                                           boolean simpleNames)

formatTypes

public static java.lang.String formatTypes(java.lang.Iterable<? extends java.lang.reflect.Type> baseTypes)

formatBusinessInterfaceDescriptors

public static java.lang.String formatBusinessInterfaceDescriptors(java.lang.Iterable<? extends BusinessInterfaceDescriptor<?>> businessInterfaceDescriptors)

addSpaceIfNeeded

public static java.lang.String addSpaceIfNeeded(java.lang.String string)

formatAsFormalParameterList

public static java.lang.String formatAsFormalParameterList(java.lang.Iterable<? extends AnnotatedParameter<?>> parameters)

formatParameter

public static java.lang.String formatParameter(AnnotatedParameter<?> parameter)

formatModifiers

public static java.lang.String formatModifiers(int modifiers)

formatActualTypeArguments

public static java.lang.String formatActualTypeArguments(java.lang.reflect.Type type)

formatActualTypeArguments

public static java.lang.String formatActualTypeArguments(java.lang.reflect.Type[] actualTypeArguments)

wrapIfNecessary

public static java.lang.String wrapIfNecessary(java.lang.String string,
                                               java.lang.String prepend,
                                               java.lang.String append)

formatAnnotations

public static java.lang.String formatAnnotations(java.lang.Iterable<java.lang.annotation.Annotation> annotations)

formatAnnotations

public static java.lang.String formatAnnotations(java.lang.annotation.Annotation[] annotations)

Gets a string representation from an array of annotations

Parameters:

annotations - The annotations

Returns:

The string representation

version

public static java.lang.String version(@Deprecated
                                       java.lang.Package pkg)

Parameters:

pkg - This param is completely ignored

Returns:

the formatted version

getSimpleVersion

public static java.lang.String getSimpleVersion()

Returns:

a simple version string, i.e. no formatting is applied

version

public static java.lang.String version(java.lang.String version,
                                       java.lang.String timestamp)

formatSimpleClassName

public static java.lang.String formatSimpleClassName(java.lang.Object object)

formatSimpleClassName

public static java.lang.String formatSimpleClassName(java.lang.Class<?> javaClass)

formatAnnotatedType

public static java.lang.String formatAnnotatedType(AnnotatedType<?> type)

formatAnnotatedConstructor

public static java.lang.String formatAnnotatedConstructor(AnnotatedConstructor<?> constructor)

formatAnnotatedField

public static java.lang.String formatAnnotatedField(AnnotatedField<?> field)

formatAnnotatedMethod

public static java.lang.String formatAnnotatedMethod(AnnotatedMethod<?> method)

formatAnnotatedParameter

public static java.lang.String formatAnnotatedParameter(AnnotatedParameter<?> parameter)

getNameOfMissingClassLoaderDependency

public static java.lang.String getNameOfMissingClassLoaderDependency(java.lang.Throwable e)

Attempts to extract a name of a missing class loader dependency from an exception such as NoClassDefFoundError or ClassNotFoundException.