freemarker.template.utility

Class ClassUtil

java.lang.Object

freemarker.template.utility.ClassUtil

public class ClassUtil
extends Object

Author:

Attila Szegedi

Method Summary

Methods

Modifier and Type	Method and Description
static Class	forName(String className) Similar to Class.forName(java.lang.String), but attempts to load through the thread context class loader.
static String	getFTLTypeDescription(TemplateModel tm) Returns the type description of a value with FTL terms (not plain class name), as it should be used in type-related error messages and for debugging purposes.
static String	getShortClassName(Class pClass) Same as getShortClassName(pClass, false).
static String	getShortClassName(Class pClass, boolean shortenFreeMarkerClasses) Returns a class name without "java.lang." and "java.util." prefix; useful for printing class names in error messages.
static String	getShortClassNameOfObject(Object obj) Same as getShortClassNameOfObject(pClass, false).
static String	getShortClassNameOfObject(Object obj, boolean shortenFreeMarkerClasses) getShortClassName(Class, boolean) called with object.getClass(), but returns the fictional class name Null for a null value.

Methods inherited from class java.lang.Object

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

Method Detail

forName

public static Class forName(String className)
                     throws ClassNotFoundException

Similar to Class.forName(java.lang.String), but attempts to load through the thread context class loader. Only if thread context class loader is inaccessible, or it can't find the class will it attempt to fall back to the class loader that loads the FreeMarker classes.

Throws:

ClassNotFoundException

getShortClassName

public static String getShortClassName(Class pClass)

Same as getShortClassName(pClass, false).

Since:

2.4

getShortClassName

public static String getShortClassName(Class pClass,
                       boolean shortenFreeMarkerClasses)

Returns a class name without "java.lang." and "java.util." prefix; useful for printing class names in error messages.

Parameters:

pClass - can be null, in which case the method returns null.

shortenFreeMarkerClasses - if true, it will also shorten FreeMarker class names. The exact rules aren't specified and might change over time, but right now, freemarker.ext.beans.NumberModel for example becomes to f.e.b.NumberModel.

Since:

2.4

getShortClassNameOfObject

public static String getShortClassNameOfObject(Object obj)

Same as getShortClassNameOfObject(pClass, false).

Since:

2.4

getShortClassNameOfObject

public static String getShortClassNameOfObject(Object obj,
                               boolean shortenFreeMarkerClasses)

getShortClassName(Class, boolean) called with object.getClass(), but returns the fictional class name Null for a null value.

Since:

2.4

getFTLTypeDescription

public static String getFTLTypeDescription(TemplateModel tm)

Returns the type description of a value with FTL terms (not plain class name), as it should be used in type-related error messages and for debugging purposes. The exact format is not specified and might change over time, but currently it's something like "string (wrapper: f.t.SimpleScalar)" or "sequence+hash+string (ArrayList wrapped into f.e.b.CollectionModel)".

Since:

2.4