de.smartics.exceptions.report.data
Class ExceptionCodeReportItem

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

public final class ExceptionCodeReportItem
     
     

      
      extends 
      
      Object
     
     

Information collected on an exception code. This is the information about an enumeration element of a code class.

Constructor Summary

ExceptionCodeReportItem(Code code, com.thoughtworks.qdox.model.JavaClass typeJavadoc, com.thoughtworks.qdox.model.JavaField javadoc, PlaceHolderInfo placeHolderInfo)
Default constructor.

Method Summary

Code	getCode() Returns the instance of the code.
String	getComment() Returns the comment to the report item.
String	getDeclaringTypeName() Returns the fully qualified name of the type that declares the code.
com.thoughtworks.qdox.model.JavaField	getJavadoc() Returns the Javadoc information collected at field level.
String	getName() Returns the unique name of the report item.
PlaceHolderInfo	getPlaceHolderInfo() Returns the descriptions of the place holders.
SourceInfo	getSource() Returns the source code information about the declaration of the exception code.
String	getTypeComment() Returns the comment to the report item type.
com.thoughtworks.qdox.model.JavaClass	getTypeJavadoc() Returns the Javadoc information collected at class level.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExceptionCodeReportItem

public ExceptionCodeReportItem(Code code,
                               com.thoughtworks.qdox.model.JavaClass typeJavadoc,
                               com.thoughtworks.qdox.model.JavaField javadoc,
                               PlaceHolderInfo placeHolderInfo)
                        throws NullPointerException

Default constructor.

Parameters:

code - the instance of the code.

typeJavadoc - the Javadoc information collected at class level.

javadoc - the Javadoc information collected at field level.

placeHolderInfo - the descriptions of the place holders.

Throws:

NullPointerException - if any of the arguments is null.

Method Detail

getPlaceHolderInfo

public PlaceHolderInfo getPlaceHolderInfo()

Returns the descriptions of the place holders.

Returns:

the descriptions of the place holders.

getTypeComment

public String getTypeComment()

Returns the comment to the report item type.

Returns:

the comment to the report item type.

getName

public String getName()

Returns the unique name of the report item.

Returns:

the unique name of the report item.

getCode

public Code getCode()

Returns the instance of the code.

Returns:

the instance of the code.

getComment

public String getComment()

Returns the comment to the report item.

Returns:

the comment to the report item.

getDeclaringTypeName

public String getDeclaringTypeName()

Returns the fully qualified name of the type that declares the code.

Returns:

the fully qualified name of the type that declares the code.

getTypeJavadoc

public com.thoughtworks.qdox.model.JavaClass getTypeJavadoc()

Returns the Javadoc information collected at class level.

Returns:

the Javadoc information collected at class level.

getJavadoc

public com.thoughtworks.qdox.model.JavaField getJavadoc()

Returns the Javadoc information collected at field level.

Returns:

the Javadoc information collected at field level.

getSource

public SourceInfo getSource()

Returns the source code information about the declaration of the exception code.

Returns:

the source code information about the declaration of the exception code.