org.acm.seguin.pretty
Class JavadocTags

java.lang.Object
  extended by org.acm.seguin.pretty.JavadocTags

public class JavadocTags
extends java.lang.Object

Stores all the javadoc tags, rather than getting them directly from the file settings. This will allow the descriptions to be unit tested.

Since:
2.6.32
Author:
Chris Seguin

Method Summary
static JavadocTags get()
          Description of the Method
 java.lang.String getConstructorDescr()
           
 java.lang.String getExceptionDescr()
          Gets the exceptionDescr attribute of the JavadocTags object
 java.lang.String getExceptionTag()
          Gets the exceptionTag attribute of the JavadocTags object
 java.lang.String getParamDescr()
          Gets the paramDescr attribute of the JavadocTags object
 java.lang.String getReturnDescr()
          Gets the returnDescr attribute of the JavadocTags object
 boolean isExceptionTag(java.lang.String name)
          Gets the exceptionTag attribute of the JavadocTags object
 void reload()
          Reloads from the pretty.settings file
 void setConstructorDescr(java.lang.String value)
           
 void setDebug(boolean way)
          Turns debugging on
 void setExceptionDescr(java.lang.String value)
          Sets the exceptionDescr attribute of the JavadocTags object
 void setExceptionTag(java.lang.String value)
          Sets the exceptionTag attribute of the JavadocTags object
 void setParamDescr(java.lang.String value)
          Sets the paramDescr attribute of the JavadocTags object
 void setReturnDescr(java.lang.String value)
          Sets the returnDescr attribute of the JavadocTags object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setDebug

public void setDebug(boolean way)
Turns debugging on

Parameters:
way - The new debug value
Since:
2.6.32

setExceptionDescr

public void setExceptionDescr(java.lang.String value)
Sets the exceptionDescr attribute of the JavadocTags object

Parameters:
value - The new exceptionDescr value
Since:
2.6.34

setExceptionTag

public void setExceptionTag(java.lang.String value)
Sets the exceptionTag attribute of the JavadocTags object

Parameters:
value - The new exceptionTag value
Since:
2.6.32

setParamDescr

public void setParamDescr(java.lang.String value)
Sets the paramDescr attribute of the JavadocTags object

Parameters:
value - The new paramDescr value
Since:
2.6.34

setReturnDescr

public void setReturnDescr(java.lang.String value)
Sets the returnDescr attribute of the JavadocTags object

Parameters:
value - The new returnDescr value
Since:
2.6.34

getExceptionDescr

public java.lang.String getExceptionDescr()
Gets the exceptionDescr attribute of the JavadocTags object

Returns:
The exceptionDescr value
Since:
2.6.34

getExceptionTag

public java.lang.String getExceptionTag()
Gets the exceptionTag attribute of the JavadocTags object

Returns:
The exceptionTag value
Since:
2.6.32

getParamDescr

public java.lang.String getParamDescr()
Gets the paramDescr attribute of the JavadocTags object

Returns:
The paramDescr value
Since:
2.6.34

getReturnDescr

public java.lang.String getReturnDescr()
Gets the returnDescr attribute of the JavadocTags object

Returns:
The returnDescr value
Since:
2.6.34

isExceptionTag

public boolean isExceptionTag(java.lang.String name)
Gets the exceptionTag attribute of the JavadocTags object

Parameters:
name - Description of the Parameter
Returns:
The exceptionTag value
Since:
2.6.32

reload

public void reload()
Reloads from the pretty.settings file

Since:
2.6.32

get

public static JavadocTags get()
Description of the Method

Returns:
Default description of the Return Value
Since:
2.6.32

getConstructorDescr

public java.lang.String getConstructorDescr()

setConstructorDescr

public void setConstructorDescr(java.lang.String value)