Package com.github.tadukoo.java.javadoc

Class EditableJavadoc

java.lang.Object

com.github.tadukoo.java.javadoc.Javadoc

com.github.tadukoo.java.javadoc.EditableJavadoc

All Implemented Interfaces:

JavaCodeType, JavaTokens

public class EditableJavadoc
extends Javadoc

Represents a Javadoc that can be modified

Version:

Alpha v.0.4

Author:

Logan Ferree (Tadukoo)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EditableJavadoc.EditableJavadocBuilder	A builder used to make an EditableJavadoc

Field Summary

Fields inherited from class com.github.tadukoo.java.javadoc.Javadoc

author, condensed, content, params, returnVal, since, throwsInfos, version

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, VISIBILITY_MODIFIERS

Method Summary

Modifier and Type	Method	Description
void	addContent(String content)
void	addContent(List<String> content)
void	addParam(com.github.tadukoo.util.tuple.Pair<String,String> param)
void	addParam(String name, String description)
void	addParams(List<com.github.tadukoo.util.tuple.Pair<String,String>> params)
void	addThrowsInfo(com.github.tadukoo.util.tuple.Pair<String,String> throwsInfo)
void	addThrowsInfo(String throwable, String explanation)
void	addThrowsInfos(List<com.github.tadukoo.util.tuple.Pair<String,String>> throwsInfos)
static EditableJavadoc.EditableJavadocBuilder	builder()
void	setAuthor(String author)
void	setCondensed(boolean condensed)
void	setContent(List<String> content)
void	setParams(List<com.github.tadukoo.util.tuple.Pair<String,String>> params)
void	setReturnVal(String returnVal)
void	setSince(String since)
void	setThrowsInfos(List<com.github.tadukoo.util.tuple.Pair<String,String>> throwsInfos)
void	setVersion(String version)

Methods inherited from class com.github.tadukoo.java.javadoc.Javadoc

equals, getAuthor, getContent, getJavaCodeType, getParams, getReturnVal, getSince, getThrowsInfos, getVersion, isCondensed, isEditable, toBuilderCode, 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

Method Details

builder

public static EditableJavadoc.EditableJavadocBuilder builder()

Returns:

A new EditableJavadoc.EditableJavadocBuilder to use to build a new EditableJavadoc

setCondensed

public void setCondensed(boolean condensed)

Parameters:

condensed - Whether the Javadoc is condensed or not

addContent

public void addContent(String content)

Parameters:

content - Content to be added to the Javadoc

addContent

public void addContent(List<String> content)

Parameters:

content - Content to be added to the Javadoc

setContent

public void setContent(List<String> content)

Parameters:

content - The content of the Javadoc

setAuthor

public void setAuthor(String author)

Parameters:

author - The author of the Javadoc

setVersion

public void setVersion(String version)

Parameters:

version - The version for the Javadoc

setSince

public void setSince(String since)

Parameters:

since - The "since" value for the Javadoc

addParam

public void addParam(String name,
 String description)

Parameters:

name - The name of the parameter

description - The description of the parameter

addParam

public void addParam(com.github.tadukoo.util.tuple.Pair<String,String> param)

Parameters:

param - A parameter as a pair of the name and javadoc text for it

addParams

public void addParams(List<com.github.tadukoo.util.tuple.Pair<String,String>> params)

Parameters:

params - The parameters to add to the Javadoc

setParams

public void setParams(List<com.github.tadukoo.util.tuple.Pair<String,String>> params)

Parameters:

params - The parameters in the Javadoc

setReturnVal

public void setReturnVal(String returnVal)

Parameters:

returnVal - The return string in the Javadoc

addThrowsInfo

public void addThrowsInfo(String throwable,
 String explanation)

Parameters:

throwable - The throwable being thrown

explanation - The explanation of the throwable

addThrowsInfo

public void addThrowsInfo(com.github.tadukoo.util.tuple.Pair<String,String> throwsInfo)

Parameters:

throwsInfo - The throws info to be added to the Javadoc

addThrowsInfos

public void addThrowsInfos(List<com.github.tadukoo.util.tuple.Pair<String,String>> throwsInfos)

Parameters:

throwsInfos - The throws infos to be added to the Javadoc

setThrowsInfos

public void setThrowsInfos(List<com.github.tadukoo.util.tuple.Pair<String,String>> throwsInfos)

Parameters:

throwsInfos - The throws info for the Javadoc