Package com.github.tadukoo.java.javadoc

Class Javadoc

java.lang.Object

com.github.tadukoo.java.javadoc.Javadoc

All Implemented Interfaces:

JavaCodeType, JavaTokens

Direct Known Subclasses:

EditableJavadoc, UneditableJavadoc

public abstract class Javadoc
extends Object
implements JavaCodeType

Javadoc represents a Javadoc in Java.

Since:

Alpha v.0.3.3 (as old version that is now more like UneditableJavadoc), Alpha v.0.4 (as newer version)

Version:

Beta v.0.5

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
protected String	author	The author of the Javadoc
protected boolean	condensed	Whether the Javadoc is condensed or not
protected List<String>	content	The content of the Javadoc
protected List<com.github.tadukoo.util.tuple.Pair<String,String>>	params	The parameters in the Javadoc
protected String	returnVal	The return string in the Javadoc
protected String	since	The "since" value for the Javadoc
protected List<com.github.tadukoo.util.tuple.Pair<String,String>>	throwsInfos	The throws info in the Javadoc
protected String	version	The version for the Javadoc

Fields inherited from interface com.github.tadukoo.java.JavaCodeType

NEWLINE_WITH_2_TABS, NEWLINE_WITH_4_TABS

Fields inherited from interface com.github.tadukoo.java.JavaTokens

ABSTRACT_MODIFIER, ANNOTATION_START_TOKEN, ASSIGNMENT_OPERATOR_TOKEN, BLOCK_CLOSE_TOKEN, BLOCK_OPEN_TOKEN, CLASS_TOKEN, EXTENDS_TOKEN, FINAL_MODIFIER, IMPLEMENTS_TOKEN, IMPORT_TOKEN, JAVADOC_AUTHOR_TOKEN, JAVADOC_LINE_TOKEN, JAVADOC_PARAM_TOKEN, JAVADOC_RETURN_TOKEN, JAVADOC_SINCE_TOKEN, JAVADOC_START_TOKEN, JAVADOC_VERSION_TOKEN, LIST_SEPARATOR_TOKEN, MODIFIERS, MULTI_LINE_COMMENT_CLOSE_TOKEN, MULTI_LINE_COMMENT_START_TOKEN, PACKAGE_TOKEN, PARAMETER_CLOSE_TOKEN, PARAMETER_OPEN_TOKEN, PRIVATE_MODIFIER, PROTECTED_MODIFIER, PUBLIC_MODIFIER, SEMICOLON, SINGLE_LINE_COMMENT_TOKEN, STATIC_MODIFIER, THROWS_TOKEN, TYPE_PARAMETER_CLOSE_TOKEN, TYPE_PARAMETER_OPEN_TOKEN, VARARGS_TOKEN, VISIBILITY_MODIFIERS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Javadoc(boolean editable, boolean condensed, List<String> content, String author, String version, String since, List<com.github.tadukoo.util.tuple.Pair<String,String>> params, String returnVal, List<com.github.tadukoo.util.tuple.Pair<String,String>> throwsInfos)	Constructs a new Javadoc using the given parameters

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object otherJavadoc)
String	getAuthor()
List<String>	getContent()
JavaCodeTypes	getJavaCodeType()
List<com.github.tadukoo.util.tuple.Pair<String,String>>	getParams()
String	getReturnVal()
String	getSince()
List<com.github.tadukoo.util.tuple.Pair<String,String>>	getThrowsInfos()
String	getVersion()
boolean	isCondensed()
boolean	isEditable()
String	toBuilderCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.tadukoo.java.JavaCodeType

escapeQuotes

Field Details

condensed

protected boolean condensed

Whether the Javadoc is condensed or not

content

protected List<String> content

The content of the Javadoc

author

protected String author

The author of the Javadoc

version

protected String version

The version for the Javadoc

since

protected String since

The "since" value for the Javadoc

params

protected List<com.github.tadukoo.util.tuple.Pair<String,String>> params

The parameters in the Javadoc

returnVal

protected String returnVal

The return string in the Javadoc

throwsInfos

protected List<com.github.tadukoo.util.tuple.Pair<String,String>> throwsInfos

The throws info in the Javadoc

Constructor Details

Javadoc

protected Javadoc(boolean editable,
 boolean condensed,
 List<String> content,
 String author,
 String version,
 String since,
 List<com.github.tadukoo.util.tuple.Pair<String,String>> params,
 String returnVal,
 List<com.github.tadukoo.util.tuple.Pair<String,String>> throwsInfos)

Constructs a new Javadoc using the given parameters

Parameters:

editable - Whether the Javadoc is editable or not

condensed - Whether the Javadoc is condensed or not

content - The content of the Javadoc

author - The author of the Javadoc

version - The version for the Javadoc

since - The "since" value for the Javadoc

params - The parameters in the Javadoc

returnVal - The return string in the Javadoc

throwsInfos - The throws info in the Javadoc

Method Details

getJavaCodeType

public JavaCodeTypes getJavaCodeType()

Specified by:

getJavaCodeType in interface JavaCodeType

Returns:

What type this is

isEditable

public boolean isEditable()

Returns:

Whether the Javadoc is editable or not

isCondensed

public boolean isCondensed()

Returns:

Whether the Javadoc is condensed or not

getContent

public List<String> getContent()

Returns:

The content of the Javadoc

getAuthor

public String getAuthor()

Returns:

The author of the Javadoc

getVersion

public String getVersion()

Returns:

The version for the Javadoc

getSince

public String getSince()

Returns:

The "since" value for the Javadoc

getParams

public List<com.github.tadukoo.util.tuple.Pair<String,String>> getParams()

Returns:

The parameters in the Javadoc

getReturnVal

public String getReturnVal()

Returns:

The return string for the Javadoc

getThrowsInfos

public List<com.github.tadukoo.util.tuple.Pair<String,String>> getThrowsInfos()

Returns:

The throws info for the Javadoc

toString

public String toString()

Overrides:

toString in class Object

Returns:

The actual Javadoc text this class represents

equals

public boolean equals(Object otherJavadoc)

Overrides:

equals in class Object

toBuilderCode

public String toBuilderCode()

Specified by:

toBuilderCode in interface JavaCodeType

Returns:

The String of code to build the JavaCodeType