Module io.helidon.declarative.codegen.model

Package io.helidon.declarative.codegen.model.http

Class RestMethod.BuilderBase<BUILDER extends RestMethod.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends RestMethod>

java.lang.Object

io.helidon.declarative.codegen.model.http.ModelElement.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.declarative.codegen.model.http.HttpAnnotated.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.declarative.codegen.model.http.RestMethod.BuilderBase<BUILDER,PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

RestMethod.Builder

Enclosing interface:

RestMethod

public abstract static class RestMethod.BuilderBase<BUILDER extends RestMethod.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends RestMethod>
extends HttpAnnotated.BuilderBase<BUILDER,PROTOTYPE>
implements Prototype.Builder<BUILDER,PROTOTYPE>

Fluent API builder base for RestMethod.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	RestMethod.BuilderBase.RestMethodImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class io.helidon.declarative.codegen.model.http.HttpAnnotated.BuilderBase

HttpAnnotated.BuilderBase.HttpAnnotatedImpl

Nested classes/interfaces inherited from class io.helidon.declarative.codegen.model.http.ModelElement.BuilderBase

ModelElement.BuilderBase.ModelElementImpl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	addHeaderParameter(RestMethodParameter headerParameter)	Header parameters (if defined).
BUILDER	addHeaderParameter(Consumer<RestMethodParameter.Builder> consumer)	Header parameters (if defined).
BUILDER	addHeaderParameters(List<? extends RestMethodParameter> headerParameters)	Header parameters (if defined).
BUILDER	addParameter(RestMethodParameter parameter)	All parameters of this method.
BUILDER	addParameter(Consumer<RestMethodParameter.Builder> consumer)	All parameters of this method.
BUILDER	addParameters(List<? extends RestMethodParameter> parameters)	All parameters of this method.
BUILDER	addPathParameter(RestMethodParameter pathParameter)	Path parameters (if defined).
BUILDER	addPathParameter(Consumer<RestMethodParameter.Builder> consumer)	Path parameters (if defined).
BUILDER	addPathParameters(List<? extends RestMethodParameter> pathParameters)	Path parameters (if defined).
BUILDER	addQueryParameter(RestMethodParameter queryParameter)	Query parameters (if defined).
BUILDER	addQueryParameter(Consumer<RestMethodParameter.Builder> consumer)	Query parameters (if defined).
BUILDER	addQueryParameters(List<? extends RestMethodParameter> queryParameters)	Query parameters (if defined).
BUILDER	clearEntityParameter()	Clear existing value of entityParameter.
BUILDER	clearHeaderParameters()	Clear all headerParameters.
BUILDER	clearParameters()	Clear all parameters.
BUILDER	clearPathParameters()	Clear all pathParameters.
BUILDER	clearQueryParameters()	Clear all queryParameters.
BUILDER	clearStatus()	Clear existing value of status.
Optional<RestMethodParameter>	entityParameter()	Entity parameter (if defined).
BUILDER	entityParameter(RestMethodParameter entityParameter)	Entity parameter (if defined).
BUILDER	entityParameter(Consumer<RestMethodParameter.Builder> consumer)	Entity parameter (if defined).
BUILDER	entityParameter(Supplier<? extends RestMethodParameter> supplier)	Entity parameter (if defined).
BUILDER	from(RestMethod prototype)	Update this builder from an existing prototype instance.
BUILDER	from(RestMethod.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
List<RestMethodParameter>	headerParameters()	Header parameters (if defined).
BUILDER	headerParameters(List<? extends RestMethodParameter> headerParameters)	Header parameters (if defined).
Optional<HttpMethod>	httpMethod()	HTTP method of this method.
BUILDER	httpMethod(HttpMethod httpMethod)	HTTP method of this method.
Optional<TypedElementInfo>	method()	Method element info.
BUILDER	method(TypedElementInfo method)	Method element info.
BUILDER	method(Consumer<TypedElementInfo.Builder> consumer)	Method element info.
BUILDER	method(Supplier<? extends TypedElementInfo> supplier)	Method element info.
Optional<String>	name()	Method name.
BUILDER	name(String name)	Method name.
List<RestMethodParameter>	parameters()	All parameters of this method.
BUILDER	parameters(List<? extends RestMethodParameter> parameters)	All parameters of this method.
List<RestMethodParameter>	pathParameters()	Path parameters (if defined).
BUILDER	pathParameters(List<? extends RestMethodParameter> pathParameters)	Path parameters (if defined).
protected void	preBuildPrototype()	Handles providers and decorators.
List<RestMethodParameter>	queryParameters()	Query parameters (if defined).
BUILDER	queryParameters(List<? extends RestMethodParameter> queryParameters)	Query parameters (if defined).
Optional<TypeName>	returnType()	Type returned by this method.
BUILDER	returnType(TypeName returnType)	Type returned by this method.
BUILDER	returnType(Consumer<TypeName.Builder> consumer)	Type returned by this method.
BUILDER	returnType(Supplier<? extends TypeName> supplier)	Type returned by this method.
Optional<HttpStatus>	status()	HTTP Status (server side only) annotation on the method.
BUILDER	status(HttpStatus status)	HTTP Status (server side only) annotation on the method.
String	toString()
Optional<String>	uniqueName()	Unique name of the method (used for generated code).
BUILDER	uniqueName(String uniqueName)	Unique name of the method (used for generated code).
protected void	validatePrototype()	Validates required properties.

Methods inherited from class io.helidon.declarative.codegen.model.http.HttpAnnotated.BuilderBase

addComputedHeader, addComputedHeaders, addConsume, addConsumes, addHeader, addHeaders, addProduce, addProduces, clearComputedHeaders, clearConsumes, clearHeaders, clearPath, clearProduces, computedHeaders, computedHeaders, consumes, consumes, from, from, headers, headers, path, path, produces, produces

Methods inherited from class io.helidon.declarative.codegen.model.http.ModelElement.BuilderBase

addAnnotation, addAnnotation, addAnnotations, annotations, annotations, clearAnnotations, from, from, type, type, type, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(RestMethod prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(RestMethod.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

clearStatus

public BUILDER clearStatus()

Clear existing value of status.

Returns:

updated builder instance

See Also:

• status()

status

public BUILDER status(HttpStatus status)

HTTP Status (server side only) annotation on the method.

Parameters:

status - status to return

Returns:

updated builder instance

See Also:

• status()

returnType

public BUILDER returnType(TypeName returnType)

Type returned by this method.

Parameters:

returnType - return type of the method

Returns:

updated builder instance

See Also:

• returnType()

returnType

public BUILDER returnType(Consumer<TypeName.Builder> consumer)

Type returned by this method.

Parameters:

consumer - consumer of builder of return type of the method

Returns:

updated builder instance

See Also:

• returnType()

returnType

public BUILDER returnType(Supplier<? extends TypeName> supplier)

Type returned by this method.

Parameters:

supplier - supplier of return type of the method

Returns:

updated builder instance

See Also:

• returnType()

name

public BUILDER name(String name)

Method name.

Parameters:

name - name of the method

Returns:

updated builder instance

See Also:

• name()

uniqueName

public BUILDER uniqueName(String uniqueName)

Unique name of the method (used for generated code). If there is more than one method with the same name within a type, the second (and further) methods will have an index based unique name generated.

Parameters:

uniqueName - unique name of this method for generated code

Returns:

updated builder instance

See Also:

• uniqueName()

httpMethod

public BUILDER httpMethod(HttpMethod httpMethod)

HTTP method of this method.

Parameters:

httpMethod - HTTP method

Returns:

updated builder instance

See Also:

• httpMethod()

clearParameters

public BUILDER clearParameters()

Clear all parameters.

Returns:

updated builder instance

See Also:

• parameters()

parameters

public BUILDER parameters(List<? extends RestMethodParameter> parameters)

All parameters of this method.

Parameters:

parameters - method parameters

Returns:

updated builder instance

See Also:

• parameters()

addParameters

public BUILDER addParameters(List<? extends RestMethodParameter> parameters)

All parameters of this method.

Parameters:

parameters - method parameters

Returns:

updated builder instance

See Also:

• parameters()

addParameter

public BUILDER addParameter(RestMethodParameter parameter)

All parameters of this method.

Parameters:

parameter - add single method parameters

Returns:

updated builder instance

See Also:

• parameters()

addParameter

public BUILDER addParameter(Consumer<RestMethodParameter.Builder> consumer)

All parameters of this method.

Parameters:

consumer - consumer of builder for method parameters

Returns:

updated builder instance

See Also:

• parameters()

clearEntityParameter

public BUILDER clearEntityParameter()

Clear existing value of entityParameter.

Returns:

updated builder instance

See Also:

• entityParameter()

entityParameter

public BUILDER entityParameter(RestMethodParameter entityParameter)

Entity parameter (if defined).

Parameters:

entityParameter - method entity parameter

Returns:

updated builder instance

See Also:

• entityParameter()

entityParameter

public BUILDER entityParameter(Consumer<RestMethodParameter.Builder> consumer)

Entity parameter (if defined).

Parameters:

consumer - consumer of builder of method entity parameter

Returns:

updated builder instance

See Also:

• entityParameter()

entityParameter

public BUILDER entityParameter(Supplier<? extends RestMethodParameter> supplier)

Entity parameter (if defined).

Parameters:

supplier - supplier of method entity parameter

Returns:

updated builder instance

See Also:

• entityParameter()

clearHeaderParameters

public BUILDER clearHeaderParameters()

Clear all headerParameters.

Returns:

updated builder instance

See Also:

• headerParameters()

headerParameters

public BUILDER headerParameters(List<? extends RestMethodParameter> headerParameters)

Header parameters (if defined).

Parameters:

headerParameters - header parameters

Returns:

updated builder instance

See Also:

• headerParameters()

addHeaderParameters

public BUILDER addHeaderParameters(List<? extends RestMethodParameter> headerParameters)

Header parameters (if defined).

Parameters:

headerParameters - header parameters

Returns:

updated builder instance

See Also:

• headerParameters()

addHeaderParameter

public BUILDER addHeaderParameter(RestMethodParameter headerParameter)

Header parameters (if defined).

Parameters:

headerParameter - add single header parameters

Returns:

updated builder instance

See Also:

• headerParameters()

addHeaderParameter

public BUILDER addHeaderParameter(Consumer<RestMethodParameter.Builder> consumer)

Header parameters (if defined).

Parameters:

consumer - consumer of builder for header parameters

Returns:

updated builder instance

See Also:

• headerParameters()

clearQueryParameters

public BUILDER clearQueryParameters()

Clear all queryParameters.

Returns:

updated builder instance

See Also:

• queryParameters()

queryParameters

public BUILDER queryParameters(List<? extends RestMethodParameter> queryParameters)

Query parameters (if defined).

Parameters:

queryParameters - query parameters

Returns:

updated builder instance

See Also:

• queryParameters()

addQueryParameters

public BUILDER addQueryParameters(List<? extends RestMethodParameter> queryParameters)

Query parameters (if defined).

Parameters:

queryParameters - query parameters

Returns:

updated builder instance

See Also:

• queryParameters()

addQueryParameter

public BUILDER addQueryParameter(RestMethodParameter queryParameter)

Query parameters (if defined).

Parameters:

queryParameter - add single query parameters

Returns:

updated builder instance

See Also:

• queryParameters()

addQueryParameter

public BUILDER addQueryParameter(Consumer<RestMethodParameter.Builder> consumer)

Query parameters (if defined).

Parameters:

consumer - consumer of builder for query parameters

Returns:

updated builder instance

See Also:

• queryParameters()

clearPathParameters

public BUILDER clearPathParameters()

Clear all pathParameters.

Returns:

updated builder instance

See Also:

• pathParameters()

pathParameters

public BUILDER pathParameters(List<? extends RestMethodParameter> pathParameters)

Path parameters (if defined).

Parameters:

pathParameters - path parameters

Returns:

updated builder instance

See Also:

• pathParameters()

addPathParameters

public BUILDER addPathParameters(List<? extends RestMethodParameter> pathParameters)

Path parameters (if defined).

Parameters:

pathParameters - path parameters

Returns:

updated builder instance

See Also:

• pathParameters()

addPathParameter

public BUILDER addPathParameter(RestMethodParameter pathParameter)

Path parameters (if defined).

Parameters:

pathParameter - add single path parameters

Returns:

updated builder instance

See Also:

• pathParameters()

addPathParameter

public BUILDER addPathParameter(Consumer<RestMethodParameter.Builder> consumer)

Path parameters (if defined).

Parameters:

consumer - consumer of builder for path parameters

Returns:

updated builder instance

See Also:

• pathParameters()

method

public BUILDER method(TypedElementInfo method)

Method element info.

Parameters:

method - method element info

Returns:

updated builder instance

See Also:

• method()

method

public BUILDER method(Consumer<TypedElementInfo.Builder> consumer)

Method element info.

Parameters:

consumer - consumer of builder of method element info

Returns:

updated builder instance

See Also:

• method()

method

public BUILDER method(Supplier<? extends TypedElementInfo> supplier)

Method element info.

Parameters:

supplier - supplier of method element info

Returns:

updated builder instance

See Also:

• method()

status

public Optional<HttpStatus> status()

HTTP Status (server side only) annotation on the method.

Returns:

status to return

returnType

public Optional<TypeName> returnType()

Type returned by this method.

Returns:

return type of the method

name

public Optional<String> name()

Method name.

Returns:

name of the method

uniqueName

public Optional<String> uniqueName()

Unique name of the method (used for generated code). If there is more than one method with the same name within a type, the second (and further) methods will have an index based unique name generated.

Returns:

unique name of this method for generated code

httpMethod

public Optional<HttpMethod> httpMethod()

HTTP method of this method.

Returns:

HTTP method

parameters

public List<RestMethodParameter> parameters()

All parameters of this method.

Returns:

method parameters

entityParameter

public Optional<RestMethodParameter> entityParameter()

Entity parameter (if defined).

Returns:

method entity parameter

headerParameters

public List<RestMethodParameter> headerParameters()

Header parameters (if defined).

Returns:

header parameters

queryParameters

public List<RestMethodParameter> queryParameters()

Query parameters (if defined).

Returns:

query parameters

pathParameters

public List<RestMethodParameter> pathParameters()

Path parameters (if defined).

Returns:

path parameters

method

public Optional<TypedElementInfo> method()

Method element info.

Returns:

method element info

toString

public String toString()

Overrides:

toString in class HttpAnnotated.BuilderBase<BUILDER extends RestMethod.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends RestMethod>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class HttpAnnotated.BuilderBase<BUILDER extends RestMethod.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends RestMethod>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class HttpAnnotated.BuilderBase<BUILDER extends RestMethod.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends RestMethod>