Package com.github.tadukoo.java.javadoc

Class JavadocBuilder<JavadocType extends Javadoc>

java.lang.Object

com.github.tadukoo.java.javadoc.JavadocBuilder<JavadocType>

Direct Known Subclasses:

EditableJavadoc.EditableJavadocBuilder, UneditableJavadoc.UneditableJavadocBuilder

public abstract class JavadocBuilder<JavadocType extends Javadoc>
extends Object

A builder class to build a Javadoc. It has the following parameters:

Javadoc Parameters

Parameter	Description	Default or Required
condensed	Whether the Javadoc is condensed or not	Defaults to false
content	The content of the Javadoc	Defaults to an empty List
author	The author of the Javadoc	Defaults to null
version	The version of the Javadoc	Defaults to null
since	The "since" value of the Javadoc	Defaults to null
params	The parameters in the Javadoc	Defaults to an empty list
returnVal	The return string for the Javadoc	Defaults to null
throwsInfos	The throws info for the Javadoc	Defaults to an empty list

Since:

Alpha v.0.3.3 (within Javadoc), Alpha v.0.4 (as its own class)

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 for 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 for the Javadoc
protected String	version	The version for the Javadoc

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavadocBuilder()	Constructs a new JavadocBuilder

Method Summary

Modifier and Type	Method	Description
JavadocBuilder<JavadocType>	author(String author)
JavadocType	build()	Builds a new Javadoc using the set parameters
JavadocBuilder<JavadocType>	condensed()	Sets that the Javadoc is condensed
JavadocBuilder<JavadocType>	condensed(boolean condensed)
protected abstract JavadocType	constructJavadoc()	Constructs a new Javadoc using the set parameters
JavadocBuilder<JavadocType>	content(String content)
JavadocBuilder<JavadocType>	content(List<String> content)
JavadocBuilder<JavadocType>	copy(Javadoc javadoc)	Copies the settings from the given Javadoc to this builder
JavadocBuilder<JavadocType>	param(com.github.tadukoo.util.tuple.Pair<String,String> param)
JavadocBuilder<JavadocType>	param(String name, String description)
JavadocBuilder<JavadocType>	params(List<com.github.tadukoo.util.tuple.Pair<String,String>> params)
JavadocBuilder<JavadocType>	returnVal(String returnVal)
JavadocBuilder<JavadocType>	since(String since)
JavadocBuilder<JavadocType>	throwsInfo(com.github.tadukoo.util.tuple.Pair<String,String> throwsInfo)
JavadocBuilder<JavadocType>	throwsInfo(String throwable, String explanation)
JavadocBuilder<JavadocType>	throwsInfos(List<com.github.tadukoo.util.tuple.Pair<String,String>> throwsInfos)
JavadocBuilder<JavadocType>	version(String version)

Methods inherited from class java.lang.Object

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

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 for the Javadoc

throwsInfos

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

The throws info for the Javadoc

Constructor Details

JavadocBuilder

protected JavadocBuilder()

Constructs a new JavadocBuilder

Method Details

copy

public JavadocBuilder<JavadocType> copy(Javadoc javadoc)

Copies the settings from the given Javadoc to this builder

Parameters:

javadoc - The Javadoc to copy settings from

Returns:

this, to continue building

condensed

public JavadocBuilder<JavadocType> condensed(boolean condensed)

Parameters:

condensed - Whether the Javadoc is condensed or not

Returns:

this, to continue building

condensed

public JavadocBuilder<JavadocType> condensed()

Sets that the Javadoc is condensed

Returns:

this, to continue building

content

public JavadocBuilder<JavadocType> content(List<String> content)

Parameters:

content - The content of the Javadoc

Returns:

this, to continue building

content

public JavadocBuilder<JavadocType> content(String content)

Parameters:

content - Content for the Javadoc (to add to the List)

Returns:

this, to continue building

author

public JavadocBuilder<JavadocType> author(String author)

Parameters:

author - The author of the Javadoc

Returns:

this, to continue building

version

public JavadocBuilder<JavadocType> version(String version)

Parameters:

version - The version for the Javadoc

Returns:

this, to continue building

since

public JavadocBuilder<JavadocType> since(String since)

Parameters:

since - The "since" value for the Javadoc

Returns:

this, to continue building

params

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

Parameters:

params - The parameters in the Javadoc

Returns:

this, to continue building

param

public JavadocBuilder<JavadocType> param(com.github.tadukoo.util.tuple.Pair<String,String> param)

Parameters:

param - A parameter in the Javadoc to add to the list

Returns:

this, to continue building

param

public JavadocBuilder<JavadocType> param(String name,
 String description)

Parameters:

name - The name of the parameter in the Javadoc to add to the list

description - The description of the parameter in the Javadoc to add to the list

Returns:

this, to continue building

returnVal

public JavadocBuilder<JavadocType> returnVal(String returnVal)

Parameters:

returnVal - The return string for the Javadoc

Returns:

this, to continue building

throwsInfos

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

Parameters:

throwsInfos - The throws info for the Javadoc

Returns:

this, to continue building

throwsInfo

public JavadocBuilder<JavadocType> throwsInfo(com.github.tadukoo.util.tuple.Pair<String,String> throwsInfo)

Parameters:

throwsInfo - A throws info for the Javadoc

Returns:

this, to continue building

throwsInfo

public JavadocBuilder<JavadocType> throwsInfo(String throwable,
 String explanation)

Parameters:

throwable - The throwable being thrown for the Javadoc

explanation - The explanation of the throwable being thrown

Returns:

this, to continue building

build

public JavadocType build()

Builds a new Javadoc using the set parameters

Returns:

The newly built Javadoc

constructJavadoc

protected abstract JavadocType constructJavadoc()

Constructs a new Javadoc using the set parameters

Returns:

The newly built Javadoc