io.vertx.codegen.doc

Class Token

java.lang.Object

io.vertx.codegen.doc.Token

Direct Known Subclasses:

Token.InlineTag, Token.LineBreak, Token.Text

public abstract class Token
extends Object

A comment token.

Author:

Julien Viet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Token.InlineTag
static class	Token.LineBreak
static class	Token.Text

Constructor Summary

Constructors

Constructor and Description
Token(String value)

Method Summary

Modifier and Type	Method and Description
String	getValue()
boolean	isInlineTag()
boolean	isLineBreak()
boolean	isText()
static Function<Token,Token>	tagMapper(Elements elementUtils, Types typeUtils, TypeElement ownerElt) Create a tag mapper that remaps tags with extra contexutal info like @link tags.
static String	toHtml(List<Token> tokens, String margin, Function<Tag.Link,String> linkToHtml, String sep) Render a list of tokens to HTML markup and return it.
static void	toHtml(List<Token> tokens, String margin, Function<Tag.Link,String> linkToHtml, String sep, PrintWriter writer) Render a list of tokens to HTML markup.
static List<Token>	tokenize(String s) Tokenize the string.

Methods inherited from class java.lang.Object

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

Constructor Detail

Token

public Token(String value)

Method Detail

tokenize

public static List<Token> tokenize(String s)

Tokenize the string.

Parameters:

s - the string to tokenize

Returns:

the tokens after analysis

isText

public boolean isText()

Returns:

true if the token is text

isInlineTag

public boolean isInlineTag()

Returns:

true if the token is an inline tag

isLineBreak

public boolean isLineBreak()

Returns:

true if the token is line break

getValue

public String getValue()

Returns:

the token text

tagMapper

public static Function<Token,Token> tagMapper(Elements elementUtils,
                                              Types typeUtils,
                                              TypeElement ownerElt)

Create a tag mapper that remaps tags with extra contexutal info like @link tags.

Parameters:

elementUtils - the element utils

typeUtils - the type utils

ownerElt - the type element in which this tag is declared

Returns:

the mapper

toHtml

public static String toHtml(List<Token> tokens,
                            String margin,
                            Function<Tag.Link,String> linkToHtml,
                            String sep)

Render a list of tokens to HTML markup and return it.

Parameters:

tokens - the tokens to render

margin - the left margin

linkToHtml - the function that renders a tag link to HTML markup

sep - the separator

Returns:

the rendered HTML

toHtml

public static void toHtml(List<Token> tokens,
                          String margin,
                          Function<Tag.Link,String> linkToHtml,
                          String sep,
                          PrintWriter writer)

Render a list of tokens to HTML markup.

Parameters:

tokens - the tokens to render

margin - the left margin

linkToHtml - the function that renders a tag link to HTML markup

sep - the separator

writer - the writer for output