com.phoenixnap.oss.ramlapisync.javadoc

Class JavaDocEntry

java.lang.Object

com.phoenixnap.oss.ramlapisync.javadoc.JavaDocEntry

public class JavaDocEntry
extends Object

A class which will accept a raw chunk of javadoc as a string, clean away useless characters and provide easy access to portions of it

Since:

0.0.1

Author:

Kurt Paris

Constructor Summary

Constructors

Constructor and Description
JavaDocEntry(String rawJavaDoc) Constructor which accepts a raw unprocessed chunk of javadoc and extracts meaningful portions which are stored for RAML generation

Method Summary

Modifier and Type	Method and Description
String	getComment() Returns the Main comment
Map<Integer,String>	getErrorComments() Gets the Exception comments //TODO
Map<String,String>	getParameterComments() Returns the Parameter Comments
String	getReturnTypeComment() returns the comment for the return type
void	merge(JavaDocEntry entry) Due to inheritance we can have multiple java doc entries for the same entry.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaDocEntry

public JavaDocEntry(String rawJavaDoc)

Constructor which accepts a raw unprocessed chunk of javadoc and extracts meaningful portions which are stored for RAML generation

Parameters:

rawJavaDoc - The String representing an raw chunck of javadoc for a class or method

Method Detail

getComment

public String getComment()

Returns the Main comment

Returns:

String

getParameterComments

public Map<String,String> getParameterComments()

Returns the Parameter Comments

Returns:

Map of Parameter comments keyed by Parameter name

getReturnTypeComment

public String getReturnTypeComment()

returns the comment for the return type

Returns:

String with comment for return type

getErrorComments

public Map<Integer,String> getErrorComments()

Gets the Exception comments //TODO

Returns:

Empty Map for now

toString

public String toString()

Overrides:

toString in class Object

merge

public void merge(JavaDocEntry entry)

Due to inheritance we can have multiple java doc entries for the same entry. As such we need to combine or overwrite and keep the most meaningful set of comments we can for this particular entry Different areas of javadoc (comment, parameter comment, etc) are evaluated seperately so that we keep the most meaningful fragment.

Parameters:

entry - The JavaDocEntry to be used and integrated into this entry