Vert.x 4.5.13 · io.vertx.codegen.doc.Text · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv final List<Token>	tokens
pack-priv final String	value

Access	Constructor and Description
public	Text(String value)
private	Text(String value, List<Token> tokens)

Method Summary

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 List<Token>	Returns: the tokens of this comment getTokens()
public String	Returns: the text value getValue()
public Text	Returns: the new text object map(Function<Token, Token> the mapping function mapping) Returns a new text object with tokens mapped by the `mapper` function.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

tokens	back to summary
pack-priv final List<Token> tokens

value	back to summary
pack-priv final String value

Text	back to summary
public Text(String value)

Text	back to summary
private Text(String value, List<Token> tokens)

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.

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.

getTokens	back to summary
public List<Token> getTokens() Returns:List<Token> the tokens of this comment

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

map back to summary

map	back to summary
public Text map(Function<Token, Token> mapping) Returns a new text object with tokens mapped by the `mapper` function. Parameters mapping:Function<Token, Token> the mapping function Returns:Text the new text object

public Text map(Function<Token, Token> mapping)

Returns a new text object with tokens mapped by the mapper function.

Parameters

mapping:Function<Token, Token>: the mapping function

Returns:Text

the new text object

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

public Class Text

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail