Modifier and Type	Class and Description
public static class	Tag.Link A link tag providing information of element target of the link.
public static class	Tag.Param

Modifier and Type	Field and Description
pack-priv final String	name
pack-priv final String	value

Access	Constructor and Description
public	Tag(String name, String value)

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: the tag name getName()
public String	Returns: the tag value getValue()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

name	back to summary
pack-priv final String name

value	back to summary
pack-priv final String value

Tag	back to summary
public Tag(String name, String value)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getName	back to summary
public String getName() Returns:String the tag name

getValue	back to summary
public String getValue() Returns:String the tag value

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

io.vertx.codegen.doc back to summary

public Class Tag.Link

Class Inheritance

extends Tag

java.lang.Object
io.vertx.codegen.doc.Tag
io.vertx.codegen.doc.Tag.Link

A link tag providing information of element target of the link.

Field Summary

Modifier and Type	Field and Description
pack-priv final String	label
pack-priv final Element	targetElement
pack-priv final TypeInfo	targetType

Inherited from io.vertx.codegen.doc.Tag:: name value

Constructor Summary

Access	Constructor and Description
public	Link(String rawValue, Element targetElement, TypeInfo type, String label)

Method Summary

Modifier and Type	Method and Description
public String	Returns: the target label, it may be an empty string getLabel()
public Element	Returns: the target element like a type, a method, a constructor or a field getTargetElement()
public TypeInfo	Returns: the target element owner type, either the type if the target element is a type, otherwise the type declaring the element as its member getTargetType()

Inherited from io.vertx.codegen.doc.Tag:: equals getName getValue toString

Field Detail

label	back to summary
pack-priv final String label

targetElement	back to summary
pack-priv final Element targetElement

targetType	back to summary
pack-priv final TypeInfo targetType

Constructor Detail

Link	back to summary
public Link(String rawValue, Element targetElement, TypeInfo type, String label)

Method Detail

getLabel	back to summary
public String getLabel() Returns:String the target label, it may be an empty string

getTargetElement	back to summary
public Element getTargetElement() Returns:Element the target element like a type, a method, a constructor or a field

getTargetType	back to summary
public TypeInfo getTargetType() Returns:TypeInfo the target element owner type, either the type if the target element is a type, otherwise the type declaring the element as its member

io.vertx.codegen.doc back to summary

public Class Tag.Param

Class Inheritance

extends Tag

java.lang.Object
io.vertx.codegen.doc.Tag
io.vertx.codegen.doc.Tag.Param

Field Summary

Modifier and Type	Field and Description
private static final Pattern	PARAM_PATTERN
pack-priv final String	paramDescription
pack-priv final String	paramName

Inherited from io.vertx.codegen.doc.Tag:: name value

Constructor Summary

Access	Constructor and Description
public	Param(Tag other)
public	Param(String name, String value)

Method Summary

Modifier and Type	Method and Description
public String	getParamDescription()
public String	getParamName()

Inherited from io.vertx.codegen.doc.Tag:: equals getName getValue toString

Field Detail

PARAM_PATTERN	back to summary
private static final Pattern PARAM_PATTERN

paramDescription	back to summary
pack-priv final String paramDescription

paramName	back to summary
pack-priv final String paramName

Constructor Detail

Param	back to summary
public Param(Tag other)

Param	back to summary
public Param(String name, String value)

Method Detail

getParamDescription	back to summary
public String getParamDescription()

getParamName	back to summary
public String getParamName()

public Class Tag

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Tag.Link

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Tag.Param

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail