Class Method.Builder

java.lang.Object

io.helidon.codegen.classmodel.Executable.Builder<Method.Builder, Method>

io.helidon.codegen.classmodel.Method.Builder

All Implemented Interfaces:

ContentBuilder<Method.Builder>, Builder<Method.Builder, Method>, Supplier<Method>

Enclosing class:

Method

public static final class Method.Builder
extends Executable.Builder<Method.Builder, Method>

Fluent API builder for Method.

Method Summary

Modifier and Type	Method	Description
Method.Builder	addAnnotation(Annotation annotation)	Add new annotation to the component.
Method.Builder	addAnnotation(Annotation.Builder builder)	Add new annotation to the component.
Method.Builder	addAnnotation(Annotation annotation)	Add new annotation to the component.
Method.Builder	addAnnotation(Consumer<Annotation.Builder> consumer)	Add new annotation to the component.
Method.Builder	addDescriptionLine(String line)
Method.Builder	addGenericArgument(TypeArgument typeArgument)	Add generic argument to be declared by this method.
Method	build()	Build the instance from this builder.
Method.Builder	content(List<String> content)	Set new content.
Method.Builder	description(String description)
Method.Builder	description(List<String> description)
Method.Builder	from(TypedElementInfo methodInfo)	Create all method metadata from the provided method information.
Method.Builder	includeImport(boolean includeImport)	Whether to include import type information among the imports.
Method.Builder	isAbstract(boolean isAbstract)	Whether this method is abstract.
Method.Builder	isDefault(boolean isDefault)	Whether this method is default.
Method.Builder	isFinal(boolean isFinal)	Whether this method is final.
Method.Builder	isStatic(boolean isStatic)	Whether this method is static.
Method.Builder	name(String name)
Method.Builder	returnType(Returns returnType)	Set return type of the method.
Method.Builder	returnType(TypeName type)	Set return type of the method.
Method.Builder	returnType(TypeName type, String description)	Set return type of the method.
Method.Builder	returnType(Consumer<Returns.Builder> consumer)	Set return type of the method.
Method.Builder	returnType(Supplier<Returns> supplier)	Set return type of the method.

Methods inherited from class Executable.Builder

accessModifier, addContent, addContent, addJavadocTag, addParameter, addParameter, addParameter, addParameter, addThrows, addThrows, addThrows, addThrows, addThrows, addTypeToContent, clearContent, decreaseContentPadding, generateJavadoc, increaseContentPadding, javadoc, padContent, padContent

Modifier and Type	Method	Description
Method.Builder	accessModifier(AccessModifier accessModifier)
Method.Builder	addContent(TypeName typeName)	Add type name to content, correctly handling imports.
Method.Builder	addContent(String line)	Add text line to the content.
Method.Builder	addJavadocTag(String tag, String description)
Method.Builder	addParameter(Parameter parameter)	Add new method parameter.
Method.Builder	addParameter(TypeName type, String name)	Add a new method parameter.
Method.Builder	addParameter(Consumer<Parameter.Builder> consumer)	Add new method parameter.
Method.Builder	addParameter(Supplier<Parameter> supplier)	Add new method parameter.
Method.Builder	addThrows(Throws exception)	Add a declared throws definition.
Method.Builder	addThrows(TypeName thrownType)	Add a declared throws definition.
Method.Builder	addThrows(TypeName exception, String description)	Add a declared throws definition.
Method.Builder	addThrows(Consumer<Throws.Builder> consumer)	Add a declared throws definition.
Method.Builder	addThrows(Supplier<Throws> supplier)	Add a declared throws definition.
Method.Builder	addTypeToContent(String typeName)	Obtained fully qualified type name is enclosed between ClassModel.TYPE_TOKEN tokens.
Method.Builder	clearContent()	Clears created content.
Method.Builder	decreaseContentPadding()	Method for manual padding decrement.
Method.Builder	generateJavadoc(boolean generateJavadoc)
Method.Builder	increaseContentPadding()	Method for manual padding increment.
Method.Builder	javadoc(Javadoc javadoc)
Method.Builder	padContent()	Adds single padding.
Method.Builder	padContent(int repetition)	Adds padding with number of repetitions.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default Method	get()
default Method.Builder	identity()	Instance of this builder as the correct type.
default Method.Builder	update(Consumer<Method.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface ContentBuilder

addContent, addContentCreate, addContentCreate, addContentCreate, addContentCreate, addContentLine, addContentLine, addContentLiteral, content

Modifier and Type	Method	Description
default Method.Builder	addContent(Class<?> type)	Obtained type is enclosed between ClassModel.TYPE_TOKEN tokens.
default Method.Builder	addContentCreate(Annotation annotation)	Add content that creates a new Annotation in the generated code that is the same as the annotation provided.
default Method.Builder	addContentCreate(ResolvedType type)	Add content that creates a new ResolvedType in the generated code that is the same as the type name provided.
default Method.Builder	addContentCreate(TypedElementInfo element)	Add content that creates a new TypedElementInfo in the generated code that is the same as the element provided.
default Method.Builder	addContentCreate(TypeName typeName)	Add content that creates a new TypeName in the generated code that is the same as the type name provided.
default Method.Builder	addContentLine()	Add a new line (empty).
default Method.Builder	addContentLine(String line)	Add text line to the content.
default Method.Builder	addContentLiteral(String literal)	Adds the provided literal as content, enclosed in double quotes.
default Method.Builder	content(String content)	Set new content.

Method Details

build

public Method build()

Description copied from interface: Builder

Build the instance from this builder.

Returns:

instance of the built type

content

public Method.Builder content(List<String> content)

Description copied from interface: ContentBuilder

Set new content. This method replaces previously created content in this builder.

Specified by:

content in interface ContentBuilder<Method.Builder>

Overrides:

content in class Executable.Builder<Method.Builder, Method>

Parameters:

content - content to be set

Returns:

updated builder instance

isFinal

public Method.Builder isFinal(boolean isFinal)

Whether this method is final.

Parameters:

isFinal - method is final

Returns:

updated builder instance

isStatic

public Method.Builder isStatic(boolean isStatic)

Whether this method is static.

Parameters:

isStatic - method is static

Returns:

updated builder instance

isAbstract

public Method.Builder isAbstract(boolean isAbstract)

Whether this method is abstract.

Parameters:

isAbstract - method is abstract

Returns:

updated builder instance

isDefault

public Method.Builder isDefault(boolean isDefault)

Whether this method is default.

Parameters:

isDefault - method is default

Returns:

updated builder instance

returnType

public Method.Builder returnType(TypeName type)

Set return type of the method. Default is void.

Parameters:

type - return type

Returns:

updated builder instance

returnType

public Method.Builder returnType(TypeName type,
 String description)

Set return type of the method. Default is void.

Parameters:

type - return type

description - return type description

Returns:

updated builder instance

returnType

public Method.Builder returnType(Consumer<Returns.Builder> consumer)

Set return type of the method. Default is void.

Parameters:

consumer - return type builder consumer

Returns:

updated builder instance

returnType

public Method.Builder returnType(Supplier<Returns> supplier)

Set return type of the method. Default is void.

Parameters:

supplier - return type supplier

Returns:

updated builder instance

returnType

public Method.Builder returnType(Returns returnType)

Set return type of the method. Default is void.

Parameters:

returnType - return type

Returns:

updated builder instance

addGenericArgument

public Method.Builder addGenericArgument(TypeArgument typeArgument)

Add generic argument to be declared by this method.

Parameters:

typeArgument - argument to be declared

Returns:

updated builder instance

from

public Method.Builder from(TypedElementInfo methodInfo)

Create all method metadata from the provided method information. This will populate annotations, return type, method name etc., except for the body and javadoc.

Parameters:

methodInfo - method element information

Returns:

updated builder

description

public Method.Builder description(String description)

description

public Method.Builder description(List<String> description)

addDescriptionLine

public Method.Builder addDescriptionLine(String line)

addAnnotation

public Method.Builder addAnnotation(Annotation annotation)

Add new annotation to the component.

Parameters:

annotation - annotation instance

Returns:

updated builder instance

addAnnotation

public Method.Builder addAnnotation(Consumer<Annotation.Builder> consumer)

Add new annotation to the component.

Parameters:

consumer - annotation builder consumer

Returns:

updated builder instance

addAnnotation

public Method.Builder addAnnotation(Annotation.Builder builder)

Add new annotation to the component.

Parameters:

builder - annotation builder

Returns:

updated builder instance

addAnnotation

public Method.Builder addAnnotation(Annotation annotation)

Add new annotation to the component.

Parameters:

annotation - annotation instance

Returns:

updated builder instance

name

public Method.Builder name(String name)

includeImport

public Method.Builder includeImport(boolean includeImport)

Whether to include import type information among the imports.

Parameters:

includeImport - whether imports should be included

Returns:

updated builder instance