FileDocCategorySizeDatePackage
RendererMap.javaAPI DocApache log4j 1.2.155958Sat Aug 25 00:09:38 BST 2007org.apache.log4j.or

RendererMap

public class RendererMap extends Object
Map class objects to an {@link ObjectRenderer}.
author
Ceki Gülcü
since
version 1.0

Fields Summary
Hashtable
map
static ObjectRenderer
defaultRenderer
Constructors Summary
public RendererMap()


  
   
    map = new Hashtable();
  
Methods Summary
public static voidaddRenderer(org.apache.log4j.spi.RendererSupport repository, java.lang.String renderedClassName, java.lang.String renderingClassName)
Add a renderer to a hierarchy passed as parameter.

    LogLog.debug("Rendering class: ["+renderingClassName+"], Rendered class: ["+
		 renderedClassName+"].");
    ObjectRenderer renderer = (ObjectRenderer)
             OptionConverter.instantiateByClassName(renderingClassName,
						    ObjectRenderer.class,
						    null);
    if(renderer == null) {
      LogLog.error("Could not instantiate renderer ["+renderingClassName+"].");
      return;
    } else {
      try {
	Class renderedClass = Loader.loadClass(renderedClassName);
	repository.setRenderer(renderedClass, renderer);
      } catch(ClassNotFoundException e) {
	LogLog.error("Could not find class ["+renderedClassName+"].", e);
      }
    }
  
public voidclear()

    map.clear();
  
public java.lang.StringfindAndRender(java.lang.Object o)
Find the appropriate renderer for the class type of the o parameter. This is accomplished by calling the {@link #get(Class)} method. Once a renderer is found, it is applied on the object o and the result is returned as a {@link String}.

    if(o == null)
      return null;
    else
      return get(o.getClass()).doRender(o);
  
public org.apache.log4j.or.ObjectRendererget(java.lang.Object o)
Syntactic sugar method that calls {@link #get(Class)} with the class of the object parameter.

    if(o == null)
      return null;
    else
      return get(o.getClass());
  
public org.apache.log4j.or.ObjectRendererget(java.lang.Class clazz)
Search the parents of clazz for a renderer. The renderer closest in the hierarchy will be returned. If no renderers could be found, then the default renderer is returned.

The search first looks for a renderer configured for clazz. If a renderer could not be found, then the search continues by looking at all the interfaces implemented by clazz including the super-interfaces of each interface. If a renderer cannot be found, then the search looks for a renderer defined for the parent (superclass) of clazz. If that fails, then all the interfaces implemented by the parent of clazz are searched and so on.

For example, if A0, A1, A2 are classes and X0, X1, X2, Y0, Y1 are interfaces where A2 extends A1 which in turn extends A0 and similarly X2 extends X1 which extends X0 and Y1 extends Y0. Let us also assume that A1 implements the Y0 interface and that A2 implements the X2 interface.

The table below shows the results returned by the get(A2.class) method depending on the renderers added to the map.

Added renderersValue returned by get(A2.class)
A0Renderer A0Renderer
A0Renderer, A1Renderer A1Renderer
X0Renderer X0Renderer
A1Renderer, X0Renderer X0Renderer

This search algorithm is not the most natural, although it is particularly easy to implement. Future log4j versions may implement a more intuitive search algorithm. However, the present algorithm should be acceptable in the vast majority of circumstances.

    //System.out.println("\nget: "+clazz);
    ObjectRenderer r = null;
    for(Class c = clazz; c != null; c = c.getSuperclass()) {
      //System.out.println("Searching for class: "+c);
      r = (ObjectRenderer) map.get(c);
      if(r != null) {
	return r;
      }
      r = searchInterfaces(c);
      if(r != null)
	return r;
    }
    return defaultRenderer;
  
public org.apache.log4j.or.ObjectRenderergetDefaultRenderer()

    return defaultRenderer;
  
public voidput(java.lang.Class clazz, org.apache.log4j.or.ObjectRenderer or)
Register an {@link ObjectRenderer} for clazz.

    map.put(clazz, or);
  
org.apache.log4j.or.ObjectRenderersearchInterfaces(java.lang.Class c)

    //System.out.println("Searching interfaces of class: "+c);

    ObjectRenderer r = (ObjectRenderer) map.get(c);
    if(r != null) {
      return r;
    } else {
      Class[] ia = c.getInterfaces();
      for(int i = 0; i < ia.length; i++) {
	r = searchInterfaces(ia[i]);
	if(r != null)
	  return r;
      }
    }
    return null;