Module com.speedment.common.codegen

Package com.speedment.common.codegen.model

Interface JavadocTag

All Superinterfaces:

HasCall<JavadocTag>, HasCopy<JavadocTag>, HasImports<JavadocTag>, HasName<JavadocTag>

All Known Implementing Classes:

DefaultJavadocTag

public interface JavadocTag
extends HasCopy<JavadocTag>, HasName<JavadocTag>, HasImports<JavadocTag>, HasCall<JavadocTag>

A model that represents a specific tag in a Javadoc block.

Since:

2.0

Author:

Emil Forslund

See Also:

Javadoc

Method Summary

Modifier and Type	Method	Description
Optional<String>	getText()	Returns the text of this javadoc tag.
Optional<String>	getValue()	Returns the value of this javadoc tag.
static JavadocTag	of(String name)	Creates a new instance implementing this interface by using the default implementation.
static JavadocTag	of(String name, String text)	Creates a new instance implementing this interface by using the default implementation.
static JavadocTag	of(String name, String value, String text)	Creates a new instance implementing this interface by using the default implementation.
JavadocTag	setText(String text)	Sets the text of this javadoc tag.
JavadocTag	setValue(String value)	Sets the value of this javadoc tag.

Methods inherited from interface com.speedment.common.codegen.model.trait.HasCall

call, call

Methods inherited from interface com.speedment.common.codegen.model.trait.HasCopy

copy

Methods inherited from interface com.speedment.common.codegen.model.trait.HasImports

add, getImports, imports, imports, imports

Methods inherited from interface com.speedment.common.codegen.model.trait.HasName

getName, setName

Method Detail

setValue

JavadocTag setValue(String value)

Sets the value of this javadoc tag. In the following examples, the value is the "foo" part:

     @param foo bar
     @return foo
 

Parameters:

value - the new value

Returns:

a reference to this model

getValue

Optional<String> getValue()

Returns the value of this javadoc tag. In the following examples, the value is the "foo" part:

     @param foo bar
     @return foo
 

Returns:

the value part of the tag or empty if none exists

setText

JavadocTag setText(String text)

Sets the text of this javadoc tag. In the following examples, the text is the "bar" part:

     @param foo bar
     @return foo
 

Parameters:

text - the new text

Returns:

a reference to this model

getText

Optional<String> getText()

Returns the text of this javadoc tag. In the following examples, the text is the "bar" part:

     @param foo bar
     @return foo
 

Returns:

the text part of the tag or empty if none exists

of

static JavadocTag of(String name)

Creates a new instance implementing this interface by using the default implementation.

Parameters:

name - the name

Returns:

the new instance

of

static JavadocTag of(String name,
                     String text)

Creates a new instance implementing this interface by using the default implementation.

Parameters:

name - the name

text - the text

Returns:

the new instance

of

static JavadocTag of(String name,
                     String value,
                     String text)

Creates a new instance implementing this interface by using the default implementation.

Parameters:

name - the name

value - the value

text - the text

Returns:

the new instance