de.smartics.exceptions.report.data
Class ExceptionCodeMapping

java.lang.Object
  de.smartics.exceptions.report.data.ExceptionCodeMapping

public class ExceptionCodeMapping
     
     

      
      extends 
      
      Object
     
     

Mapping of code to message parameters descriptors (i.e. exception classes) QDox class.

Constructor Summary

ExceptionCodeMapping()
Default constructor.

Method Summary

PlaceHolderInfo	getPlaceHolderInfo(com.thoughtworks.qdox.model.JavaClass codesEnumeration) Determines the place holder information from the code enumeration type.
PlaceHolderInfo	getPlaceHolderInfo(com.thoughtworks.qdox.model.JavaField codeEnum, PlaceHolderInfo defaultPlaceholderInfo) Determines the place holder information from the code instance in the enumeration.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExceptionCodeMapping

public ExceptionCodeMapping()

Default constructor.

Method Detail

getPlaceHolderInfo

public PlaceHolderInfo getPlaceHolderInfo(com.thoughtworks.qdox.model.JavaClass codesEnumeration)
                                   throws NullPointerException

Determines the place holder information from the code enumeration type.

Parameters:

codesEnumeration - the enumeration type to analyze.

Returns:

the place holder descriptions, the empty instance if none has been found or the class containing the placeholder information cannot be analyzed.

Throws:

NullPointerException - if codesEnumeration is null.

getPlaceHolderInfo

public PlaceHolderInfo getPlaceHolderInfo(com.thoughtworks.qdox.model.JavaField codeEnum,
                                          PlaceHolderInfo defaultPlaceholderInfo)
                                   throws NullPointerException

Determines the place holder information from the code instance in the enumeration.

Parameters:

codeEnum - the field to analyze.

defaultPlaceholderInfo - the default info to return if none is found.

Returns:

the place holder descriptions, the empty instance if none has been found or the class containing the placeholder information cannot be analyzed.

Throws:

NullPointerException - if fieldDoc is null.