Package com.github.tadukoo.java.javadoc

Class UneditableJavadoc

java.lang.Object

com.github.tadukoo.java.javadoc.Javadoc

com.github.tadukoo.java.javadoc.UneditableJavadoc

All Implemented Interfaces:

JavaCodeType, JavaTokens

public class UneditableJavadoc
extends Javadoc

Represents a Javadoc that can't be modified

Since:

Alpha v.0.3.3 (as Javadoc), Alpha v.0.4 (as UneditableJavadoc)

Version:

Alpha v.0.4

Author:

Logan Ferree (Tadukoo)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UneditableJavadoc.UneditableJavadocBuilder	A builder used to make an UneditableJavadoc.

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
static UneditableJavadoc.UneditableJavadocBuilder	builder()

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 UneditableJavadoc.UneditableJavadocBuilder builder()

Returns:

A new UneditableJavadoc.UneditableJavadocBuilder to use to build an UneditableJavadoc