Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	JavadocFormatter.FormatJavadocScanner
pack-priv static enum	JavadocFormatter.HtmlTag
private static enum	JavadocFormatter.Sections

Field Summary

Modifier and Type	Field and Description
private static final String	CODE_HIGHLIGHT
private static final String	CODE_RESET
private static final String	CODE_UNDERLINE
private static final Map<JavadocFormatter.Sections, String>	docSections
private final boolean	escapeSequencesSupported
private static final int	INDENT
private static final String	inlineReturns
private final int	lineLimit
private static final int	MAX_LINE_LENGTH
private static final int	SHORTEST_LINE

Access	Constructor and Description
public	JavadocFormatter(int maximum line length lineLimit, boolean whether escape sequences are supported escapeSequencesSupported) Construct the formatter.

Method Summary

Modifier and Type	Method and Description
private static void	addNewLineIfNeeded(StringBuilder text)
private static void	addSpaceIfNeeded(StringBuilder text)
private static Map<StartElementTree, Integer>	countTableColumns(DocCommentTree dct)
private String	escape(String sequence)
public String	Returns: javadoc formatted to plain text formatJavadoc(String element caption that should be used header, String to format javadoc) Format javadoc to plain text.
private static JavadocFormatter.HtmlTag	getHtmlTag(Name name)
private static String	indentString(int indent)
private static void	reflow(StringBuilder text, int from, int indent, int limit)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CODE_HIGHLIGHT	back to summary
private static final String CODE_HIGHLIGHT

CODE_RESET	back to summary
private static final String CODE_RESET

CODE_UNDERLINE	back to summary
private static final String CODE_UNDERLINE

docSections	back to summary
private static final Map<JavadocFormatter.Sections, String> docSections

escapeSequencesSupported	back to summary
private final boolean escapeSequencesSupported

INDENT	back to summary
private static final int INDENT

inlineReturns	back to summary
private static final String inlineReturns

lineLimit	back to summary
private final int lineLimit

MAX_LINE_LENGTH	back to summary
private static final int MAX_LINE_LENGTH

SHORTEST_LINE	back to summary
private static final int SHORTEST_LINE

JavadocFormatter	back to summary
public JavadocFormatter(int lineLimit, boolean escapeSequencesSupported) Construct the formatter. Parameters lineLimit:int maximum line length escapeSequencesSupported:boolean whether escape sequences are supported

Method Detail

addNewLineIfNeeded	back to summary
private static void addNewLineIfNeeded(StringBuilder text)

addSpaceIfNeeded	back to summary
private static void addSpaceIfNeeded(StringBuilder text)

countTableColumns	back to summary
private static Map<StartElementTree, Integer> countTableColumns(DocCommentTree dct)

escape	back to summary
private String escape(String sequence)

formatJavadoc	back to summary
public String formatJavadoc(String header, String javadoc) Format javadoc to plain text. Parameters header:String element caption that should be used javadoc:String to format Returns:String javadoc formatted to plain text

formatJavadoc

back to summary

public String formatJavadoc(String header, String javadoc)

Format javadoc to plain text.

Parameters

header:String: element caption that should be used
javadoc:String: to format

Returns:String

javadoc formatted to plain text

getHtmlTag	back to summary
private static JavadocFormatter.HtmlTag getHtmlTag(Name name)

indentString	back to summary
private static String indentString(int indent)

reflow	back to summary
private static void reflow(StringBuilder text, int from, int indent, int limit)

jdk.internal.shellsupport.doc back to summary

private Class JavadocFormatter.FormatJavadocScanner

Class Inheritance

extends DocTreeScanner<Object, Object>

java.lang.Object
com.sun.source.util.DocTreeScanner
jdk.internal.shellsupport.doc.JavadocFormatter.FormatJavadocScanner

Field Summary

Modifier and Type	Field and Description
pack-priv Stack<List<Integer>>	cellsStack
pack-priv Stack<Integer>	defStack
pack-priv Stack<List<Boolean>>	headerStack
private int	indent
private DocTree	lastNode
private int	limit
pack-priv Stack<Integer>	listStack
private boolean	pre
private int	reflownTo
private final StringBuilder	result
private Map<StartElementTree, Integer>	tableColumns
pack-priv Stack<Integer>	tableStack
private final JavacTask	task
private final DocTrees	trees

Constructor Summary

Access	Constructor and Description
public	FormatJavadocScanner(StringBuilder result, JavacTask task)

Method Summary

Modifier and Type	Method and Description
public Object	formatDef(CharSequence name, List<? extends DocTree> description)
private void	handleEndElement(Name name)
private void	reflowTillNow()
public Object	scan(DocTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.scan. Scans a single node.
private void	startSection(JavadocFormatter.Sections current)
public Object	visitDocComment(DocCommentTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitDocComment. Implements com.sun.source.doctree.DocTreeVisitor.visitDocComment. Visits a `DocCommentTree` node.
public Object	visitEndElement(EndElementTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitEndElement. Implements com.sun.source.doctree.DocTreeVisitor.visitEndElement. Visits an `EndElementTree` node.
public Object	visitEntity(EntityTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitEntity. Implements com.sun.source.doctree.DocTreeVisitor.visitEntity. Visits an `EntityTree` node.
public Object	visitEscape(EscapeTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitEscape. Overrides default com.sun.source.doctree.DocTreeVisitor.visitEscape. Visits an `EscapeTree` node.
public Object	visitLink(LinkTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitLink. Implements com.sun.source.doctree.DocTreeVisitor.visitLink. Visits a `LinkTree` node.
public Object	visitLiteral(LiteralTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitLiteral. Implements com.sun.source.doctree.DocTreeVisitor.visitLiteral. Visits an `LiteralTree` node.
public Object	visitParam(ParamTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitParam. Implements com.sun.source.doctree.DocTreeVisitor.visitParam. Visits a `ParamTree` node.
public Object	visitReturn(ReturnTree node, Object not `null` to force the node to be formatted as a block tag p) Overrides com.sun.source.util.DocTreeScanner.visitReturn. Implements com.sun.source.doctree.DocTreeVisitor.visitReturn. Visits a `ReturnTree` node.
public Object	visitStartElement(StartElementTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitStartElement. Implements com.sun.source.doctree.DocTreeVisitor.visitStartElement. Visits a `StartElementTree` node.
public Object	visitText(TextTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitText. Implements com.sun.source.doctree.DocTreeVisitor.visitText. Visits a `TextTree` node.
public Object	visitThrows(ThrowsTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitThrows. Implements com.sun.source.doctree.DocTreeVisitor.visitThrows. Visits a `ThrowsTree` node.

Field Detail

cellsStack	back to summary
pack-priv Stack<List<Integer>> cellsStack

defStack	back to summary
pack-priv Stack<Integer> defStack

headerStack	back to summary
pack-priv Stack<List<Boolean>> headerStack

indent	back to summary
private int indent

lastNode	back to summary
private DocTree lastNode

limit	back to summary
private int limit

listStack	back to summary
pack-priv Stack<Integer> listStack

pre	back to summary
private boolean pre

reflownTo	back to summary
private int reflownTo

result	back to summary
private final StringBuilder result

tableColumns	back to summary
private Map<StartElementTree, Integer> tableColumns

tableStack	back to summary
pack-priv Stack<Integer> tableStack

task	back to summary
private final JavacTask task

trees	back to summary
private final DocTrees trees

Constructor Detail

FormatJavadocScanner	back to summary
public FormatJavadocScanner(StringBuilder result, JavacTask task)

Method Detail

formatDef	back to summary
public Object formatDef(CharSequence name, List<? extends DocTree> description)

handleEndElement	back to summary
private void handleEndElement(Name name)

reflowTillNow	back to summary
private void reflowTillNow()

scan	back to summary
public Object scan(DocTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.scan. Doc from com.sun.source.util.DocTreeScanner.scan. Scans a single node. Annotations @Override @DefinedBy:COMPILER_TREE

scan

back to summary

public Object scan(DocTree node, Object p)

Overrides com.sun.source.util.DocTreeScanner.scan.

Doc from com.sun.source.util.DocTreeScanner.scan.

Scans a single node.

Annotations

@Override
@DefinedBy:COMPILER_TREE

startSection	back to summary
private void startSection(JavadocFormatter.Sections current)

visitDocComment back to summary

visitDocComment	back to summary
public Object visitDocComment(DocCommentTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitDocComment. Implements com.sun.source.doctree.DocTreeVisitor.visitDocComment. Doc from com.sun.source.util.DocTreeScanner.visitDocComment. Visits a `DocCommentTree` node. Annotations @Override @DefinedBy:COMPILER_TREE

public Object visitDocComment(DocCommentTree node, Object p)

Overrides com.sun.source.util.DocTreeScanner.visitDocComment.

Implements com.sun.source.doctree.DocTreeVisitor.visitDocComment.

Doc from com.sun.source.util.DocTreeScanner.visitDocComment.

Visits a DocCommentTree node.

Annotations

@Override
@DefinedBy:COMPILER_TREE

visitEndElement back to summary

visitEndElement	back to summary
public Object visitEndElement(EndElementTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitEndElement. Implements com.sun.source.doctree.DocTreeVisitor.visitEndElement. Doc from com.sun.source.util.DocTreeScanner.visitEndElement. Visits an `EndElementTree` node. Annotations @Override @DefinedBy:COMPILER_TREE

public Object visitEndElement(EndElementTree node, Object p)

Overrides com.sun.source.util.DocTreeScanner.visitEndElement.

Implements com.sun.source.doctree.DocTreeVisitor.visitEndElement.

Doc from com.sun.source.util.DocTreeScanner.visitEndElement.

Visits an EndElementTree node.

Annotations

@Override
@DefinedBy:COMPILER_TREE

visitEntity back to summary

visitEntity	back to summary
public Object visitEntity(EntityTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitEntity. Implements com.sun.source.doctree.DocTreeVisitor.visitEntity. Doc from com.sun.source.util.DocTreeScanner.visitEntity. Visits an `EntityTree` node. Annotations @Override @DefinedBy:COMPILER_TREE

public Object visitEntity(EntityTree node, Object p)

Overrides com.sun.source.util.DocTreeScanner.visitEntity.

Implements com.sun.source.doctree.DocTreeVisitor.visitEntity.

Doc from com.sun.source.util.DocTreeScanner.visitEntity.

Visits an EntityTree node.

Annotations

@Override
@DefinedBy:COMPILER_TREE

visitEscape back to summary

visitEscape	back to summary
public Object visitEscape(EscapeTree node, Object p) Overrides com.sun.source.util.DocTreeScanner.visitEscape. Overrides default com.sun.source.doctree.DocTreeVisitor.visitEscape. Doc from com.sun.source.util.DocTreeScanner.visitEscape. Visits an `EscapeTree` node. Annotations @Override @DefinedBy:COMPILER_TREE

public Object visitEscape(EscapeTree node, Object p)

Overrides com.sun.source.util.DocTreeScanner.visitEscape.

Overrides default com.sun.source.doctree.DocTreeVisitor.visitEscape.

Doc from com.sun.source.util.DocTreeScanner.visitEscape.

Visits an EscapeTree node.

Annotations

@Override
@DefinedBy:COMPILER_TREE

visitLink back to summary

public Object visitLink(LinkTree node, Object p)

Overrides com.sun.source.util.DocTreeScanner.visitLink.

Implements com.sun.source.doctree.DocTreeVisitor.visitLink.

Doc from com.sun.source.util.DocTreeScanner.visitLink.

Visits a LinkTree node.

Annotations

@Override
@DefinedBy:COMPILER_TREE

visitLiteral back to summary

public Object visitLiteral(LiteralTree node, Object p)

Overrides com.sun.source.util.DocTreeScanner.visitLiteral.

Implements com.sun.source.doctree.DocTreeVisitor.visitLiteral.

Doc from com.sun.source.util.DocTreeScanner.visitLiteral.

Visits an LiteralTree node.

Annotations

@Override
@DefinedBy:COMPILER_TREE

visitParam back to summary

public Object visitParam(ParamTree node, Object p)

Overrides com.sun.source.util.DocTreeScanner.visitParam.

Implements com.sun.source.doctree.DocTreeVisitor.visitParam.

Doc from com.sun.source.util.DocTreeScanner.visitParam.

Visits a ParamTree node.

Annotations

@Override
@DefinedBy:COMPILER_TREE

visitReturn back to summary

public Object visitReturn(ReturnTree node, Object p)

Overrides com.sun.source.util.DocTreeScanner.visitReturn.

Implements com.sun.source.doctree.DocTreeVisitor.visitReturn.

Doc from com.sun.source.util.DocTreeScanner.visitReturn.

Visits a ReturnTree node. @return is a bimodal tag and can be used as either a block tag or an inline tag. If the parameter p is null, the node will be formatted according to the value of ReturnTree#isInline(). If the parameter is not null, the node will be formatted as a block tag.

Parameters

p:Object: not null to force the node to be formatted as a block tag

Annotations

@Override
@DefinedBy:COMPILER_TREE

visitStartElement back to summary

public Object visitStartElement(StartElementTree node, Object p)

Overrides com.sun.source.util.DocTreeScanner.visitStartElement.

Implements com.sun.source.doctree.DocTreeVisitor.visitStartElement.

Doc from com.sun.source.util.DocTreeScanner.visitStartElement.

Visits a StartElementTree node.

Annotations

@Override
@DefinedBy:COMPILER_TREE

visitText back to summary

public Object visitText(TextTree node, Object p)

Overrides com.sun.source.util.DocTreeScanner.visitText.

Implements com.sun.source.doctree.DocTreeVisitor.visitText.

Doc from com.sun.source.util.DocTreeScanner.visitText.

Visits a TextTree node.

Annotations

@Override
@DefinedBy:COMPILER_TREE

visitThrows back to summary

public Object visitThrows(ThrowsTree node, Object p)

Overrides com.sun.source.util.DocTreeScanner.visitThrows.

Implements com.sun.source.doctree.DocTreeVisitor.visitThrows.

Doc from com.sun.source.util.DocTreeScanner.visitThrows.

Visits a ThrowsTree node.

Annotations

@Override
@DefinedBy:COMPILER_TREE

jdk.internal.shellsupport.doc back to summary

pack-priv final Enum JavadocFormatter.HtmlTag

Class Inheritance

extends Enum<JavadocFormatter.HtmlTag>

java.lang.Object
java.lang.Enum
jdk.internal.shellsupport.doc.JavadocFormatter.HtmlTag

Field Summary

Modifier and Type	Field and Description
public static final JavadocFormatter.HtmlTag	BLOCKQUOTE
public static final JavadocFormatter.HtmlTag	DD
public static final JavadocFormatter.HtmlTag	DL
public static final JavadocFormatter.HtmlTag	DT
public static final JavadocFormatter.HtmlTag	H1
public static final JavadocFormatter.HtmlTag	H2
public static final JavadocFormatter.HtmlTag	H3
public static final JavadocFormatter.HtmlTag	H4
public static final JavadocFormatter.HtmlTag	H5
public static final JavadocFormatter.HtmlTag	H6
public static final JavadocFormatter.HtmlTag	HTML
public static final JavadocFormatter.HtmlTag	IMG
private static final Map<String, JavadocFormatter.HtmlTag>	index
public static final JavadocFormatter.HtmlTag	LI
public static final JavadocFormatter.HtmlTag	OL
public static final JavadocFormatter.HtmlTag	P
public static final JavadocFormatter.HtmlTag	PRE
public static final JavadocFormatter.HtmlTag	TABLE
public static final JavadocFormatter.HtmlTag	TD
public static final JavadocFormatter.HtmlTag	TH
public static final JavadocFormatter.HtmlTag	TR
public static final JavadocFormatter.HtmlTag	UL

Constructor Summary

Access	Constructor and Description
private	HtmlTag()

Method Summary

Modifier and Type	Method and Description
public static JavadocFormatter.HtmlTag	get(Name tagName)
public static JavadocFormatter.HtmlTag	valueOf(String name)
public static JavadocFormatter.HtmlTag[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BLOCKQUOTE	back to summary
public static final JavadocFormatter.HtmlTag BLOCKQUOTE

DD	back to summary
public static final JavadocFormatter.HtmlTag DD

DL	back to summary
public static final JavadocFormatter.HtmlTag DL

DT	back to summary
public static final JavadocFormatter.HtmlTag DT

H1	back to summary
public static final JavadocFormatter.HtmlTag H1

H2	back to summary
public static final JavadocFormatter.HtmlTag H2

H3	back to summary
public static final JavadocFormatter.HtmlTag H3

H4	back to summary
public static final JavadocFormatter.HtmlTag H4

H5	back to summary
public static final JavadocFormatter.HtmlTag H5

H6	back to summary
public static final JavadocFormatter.HtmlTag H6

HTML	back to summary
public static final JavadocFormatter.HtmlTag HTML

IMG	back to summary
public static final JavadocFormatter.HtmlTag IMG

index	back to summary
private static final Map<String, JavadocFormatter.HtmlTag> index

LI	back to summary
public static final JavadocFormatter.HtmlTag LI

OL	back to summary
public static final JavadocFormatter.HtmlTag OL

P	back to summary
public static final JavadocFormatter.HtmlTag P

PRE	back to summary
public static final JavadocFormatter.HtmlTag PRE

TABLE	back to summary
public static final JavadocFormatter.HtmlTag TABLE

TD	back to summary
public static final JavadocFormatter.HtmlTag TD

TH	back to summary
public static final JavadocFormatter.HtmlTag TH

TR	back to summary
public static final JavadocFormatter.HtmlTag TR

UL	back to summary
public static final JavadocFormatter.HtmlTag UL

Constructor Detail

HtmlTag	back to summary
private HtmlTag()

Method Detail

get	back to summary
public static JavadocFormatter.HtmlTag get(Name tagName)

valueOf	back to summary
public static JavadocFormatter.HtmlTag valueOf(String name)

values	back to summary
public static JavadocFormatter.HtmlTag[] values()

jdk.internal.shellsupport.doc back to summary

private sealed Enum JavadocFormatter.Sections

Class Inheritance

extends Enum<JavadocFormatter.Sections>

java.lang.Object
java.lang.Enum
jdk.internal.shellsupport.doc.JavadocFormatter.Sections

Field Summary

Modifier and Type	Field and Description
public static final JavadocFormatter.Sections	PARAMS
public static final JavadocFormatter.Sections	RETURNS
public static final JavadocFormatter.Sections	THROWS
public static final JavadocFormatter.Sections	TYPE_PARAMS

Constructor Summary

Access	Constructor and Description
private	Sections()

Method Summary

Modifier and Type	Method and Description
public abstract boolean	matches(DocTree t)
public static JavadocFormatter.Sections	valueOf(String name)
public static JavadocFormatter.Sections[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

PARAMS	back to summary
public static final JavadocFormatter.Sections PARAMS

RETURNS	back to summary
public static final JavadocFormatter.Sections RETURNS

THROWS	back to summary
public static final JavadocFormatter.Sections THROWS

TYPE_PARAMS	back to summary
public static final JavadocFormatter.Sections TYPE_PARAMS

Constructor Detail

Sections	back to summary
private Sections()

Method Detail

matches	back to summary
public abstract boolean matches(DocTree t)

valueOf	back to summary
public static JavadocFormatter.Sections valueOf(String name)

values	back to summary
public static JavadocFormatter.Sections[] values()

public Class JavadocFormatter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class JavadocFormatter.FormatJavadocScanner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum JavadocFormatter.HtmlTag

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private sealed Enum JavadocFormatter.Sections

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail