de.smartics.exceptions.report.message
Class PlaceHolderHandler

java.lang.Object
  de.smartics.exceptions.report.message.PlaceHolderHandler

public final class PlaceHolderHandler
     
     

      
      extends 
      
      Object
     
     

Utilities to read place holder information from a class file.

Author:

Robert Reiner

Constructor Summary

PlaceHolderHandler(de.smartics.report.conf.ProjectConfiguration<?> config)
Utility class pattern.

Method Summary

PlaceHolderInfo

readPlaceholderDesc(ClassLoader classLoader, com.sun.javadoc.FieldDoc fieldDoc) Reads the UsedBy annotation from the field documentation and analyzes the referenced class for place holder information.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaceHolderHandler

public PlaceHolderHandler(de.smartics.report.conf.ProjectConfiguration<?> config)

Utility class pattern.

Parameters:

config - the project configuration.

Method Detail

readPlaceholderDesc

public PlaceHolderInfo readPlaceholderDesc(ClassLoader classLoader,
                                           com.sun.javadoc.FieldDoc fieldDoc)

Reads the UsedBy annotation from the field documentation and analyzes the referenced class for place holder information.

Parameters:

fieldDoc - the field to analyze.

Returns:

the place holder descriptions, the empty map if none has been found or the class containing the place holder information cannot be analyzed (a log message will be logged at WARN level).

Throws:

NullPointerException - if fieldDoc is null.