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

Modifier and Type	Field and Description
private static final Pattern	INLINE_TAG_PATTERN
private static final Pattern	LINK_REFERENCE_PATTERN
private static final Pattern	TOKEN_SPLITTER
pack-priv final String	value

Access	Constructor and Description
public	Token(String value)

Method Summary

Modifier and Type	Method and Description
public String	Returns: the token text getValue()
public boolean	Returns: true if the token is an inline tag isInlineTag()
public boolean	Returns: true if the token is line break isLineBreak()
public boolean	Returns: true if the token is text isText()
private static void	parse(String s, int prev, Matcher matcher, ArrayList<Token> events)
public static Function<Token, Token>	Returns: the mapper tagMapper(Elements the element utils elementUtils, Types the type utils typeUtils, TypeElement the type element in which this tag is declared ownerElt) Create a tag mapper that remaps tags with extra contexutal info like @link tags.
public static String	Returns: the rendered HTML toHtml(List<Token> the tokens to render tokens, String the left margin margin, Function<Tag.Link, String> the function that renders a tag link to HTML markup linkToHtml, String the separator sep) Render a list of tokens to HTML markup and return it.
public static void	toHtml(List<Token> the tokens to render tokens, String the left margin margin, Function<Tag.Link, String> the function that renders a tag link to HTML markup linkToHtml, String the separator sep, PrintWriter the writer for output writer) Render a list of tokens to HTML markup.
public static List<Token>	Returns: the tokens after analysis tokenize(String the string to tokenize s) Tokenize the string.

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

Field Detail

INLINE_TAG_PATTERN	back to summary
private static final Pattern INLINE_TAG_PATTERN

LINK_REFERENCE_PATTERN	back to summary
private static final Pattern LINK_REFERENCE_PATTERN

TOKEN_SPLITTER	back to summary
private static final Pattern TOKEN_SPLITTER

value	back to summary
pack-priv final String value

Constructor Detail

Token	back to summary
public Token(String value)

Method Detail

getValue	back to summary
public String getValue() Returns:String the token text

isInlineTag	back to summary
public boolean isInlineTag() Returns:boolean true if the token is an inline tag

isLineBreak	back to summary
public boolean isLineBreak() Returns:boolean true if the token is line break

isText	back to summary
public boolean isText() Returns:boolean true if the token is text

parse	back to summary
private static void parse(String s, int prev, Matcher matcher, ArrayList<Token> events)

tagMapper	back to summary
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:Elements the element utils typeUtils:Types the type utils ownerElt:TypeElement the type element in which this tag is declared Returns:Function<Token, Token> the mapper

tagMapper

back to summary

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:Elements: the element utils
typeUtils:Types: the type utils
ownerElt:TypeElement: the type element in which this tag is declared

Returns:Function<Token, Token>

the mapper

toHtml	back to summary
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:List<Token> the tokens to render margin:String the left margin linkToHtml:Function<Tag.Link, String> the function that renders a tag link to HTML markup sep:String the separator Returns:String the rendered HTML

toHtml

back to summary

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:List<Token>: the tokens to render
margin:String: the left margin
linkToHtml:Function<Tag.Link, String>: the function that renders a tag link to HTML markup
sep:String: the separator

Returns:String

the rendered HTML

toHtml	back to summary
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:List<Token> the tokens to render margin:String the left margin linkToHtml:Function<Tag.Link, String> the function that renders a tag link to HTML markup sep:String the separator writer:PrintWriter the writer for output

toHtml

back to summary

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:List<Token>: the tokens to render
margin:String: the left margin
linkToHtml:Function<Tag.Link, String>: the function that renders a tag link to HTML markup
sep:String: the separator
writer:PrintWriter: the writer for output

tokenize	back to summary
public static List<Token> tokenize(String s) Tokenize the string. Parameters s:String the string to tokenize Returns:List<Token> the tokens after analysis

tokenize

back to summary

public static List<Token> tokenize(String s)

Tokenize the string.

Parameters

s:String: the string to tokenize

Returns:List<Token>

the tokens after analysis

io.vertx.codegen.doc back to summary

public Class Token.InlineTag

Class Inheritance

extends Token

java.lang.Object
io.vertx.codegen.doc.Token
io.vertx.codegen.doc.Token.InlineTag

Field Summary

Modifier and Type	Field and Description
private final Tag	tag

Inherited from io.vertx.codegen.doc.Token:: value

Constructor Summary

Access	Constructor and Description
public	InlineTag(String value, Tag tag)

Method Summary

Modifier and Type	Method and Description
public Tag	Returns: the parsed tag getTag()
public boolean	isInlineTag() Overrides io.vertx.codegen.doc.Token.isInlineTag.

Inherited from io.vertx.codegen.doc.Token:: getValue isLineBreak isText tagMapper toHtml toHtml tokenize

Field Detail

tag	back to summary
private final Tag tag

Constructor Detail

InlineTag	back to summary
public InlineTag(String value, Tag tag)

Method Detail

getTag	back to summary
public Tag getTag() Returns:Tag the parsed tag

isInlineTag	back to summary
public boolean isInlineTag() Overrides io.vertx.codegen.doc.Token.isInlineTag. Returns:boolean Doc from io.vertx.codegen.doc.Token.isInlineTag. true if the token is an inline tag Annotations @Override

isInlineTag

back to summary

public boolean isInlineTag()

Overrides io.vertx.codegen.doc.Token.isInlineTag.

Returns:boolean

Doc from io.vertx.codegen.doc.Token.isInlineTag.

true if the token is an inline tag

Annotations

@Override

io.vertx.codegen.doc back to summary

public Class Token.LineBreak

Class Inheritance

extends Token

java.lang.Object
io.vertx.codegen.doc.Token
io.vertx.codegen.doc.Token.LineBreak

Field Summary

Inherited from io.vertx.codegen.doc.Token:: value

Constructor Summary

Access	Constructor and Description
public	LineBreak(String value)

Method Summary

Modifier and Type	Method and Description
public boolean	isLineBreak() Overrides io.vertx.codegen.doc.Token.isLineBreak.

Inherited from io.vertx.codegen.doc.Token:: getValue isInlineTag isText tagMapper toHtml toHtml tokenize

Constructor Detail

LineBreak	back to summary
public LineBreak(String value)

Method Detail

isLineBreak	back to summary
public boolean isLineBreak() Overrides io.vertx.codegen.doc.Token.isLineBreak. Returns:boolean Doc from io.vertx.codegen.doc.Token.isLineBreak. true if the token is line break Annotations @Override

isLineBreak

back to summary

public boolean isLineBreak()

Overrides io.vertx.codegen.doc.Token.isLineBreak.

Returns:boolean

Doc from io.vertx.codegen.doc.Token.isLineBreak.

true if the token is line break

Annotations

@Override

io.vertx.codegen.doc back to summary

public Class Token.Text

Class Inheritance

extends Token

java.lang.Object
io.vertx.codegen.doc.Token
io.vertx.codegen.doc.Token.Text

Field Summary

Inherited from io.vertx.codegen.doc.Token:: value

Constructor Summary

Access	Constructor and Description
public	Text(String value)

Method Summary

Modifier and Type	Method and Description
public boolean	isText() Overrides io.vertx.codegen.doc.Token.isText.

Inherited from io.vertx.codegen.doc.Token:: getValue isInlineTag isLineBreak tagMapper toHtml toHtml tokenize

Constructor Detail

Text	back to summary
public Text(String value)

Method Detail

isText	back to summary
public boolean isText() Overrides io.vertx.codegen.doc.Token.isText. Returns:boolean Doc from io.vertx.codegen.doc.Token.isText. true if the token is text Annotations @Override

isText

back to summary

public boolean isText()

Overrides io.vertx.codegen.doc.Token.isText.

Returns:boolean

Doc from io.vertx.codegen.doc.Token.isText.

true if the token is text

Annotations

@Override

public abstract Class Token

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Token.InlineTag

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Token.LineBreak

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class Token.Text

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail