Module io.helidon.declarative.codegen.model

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

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

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.RestEndpoint.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.declarative.codegen.model.http.ServerEndpoint.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:

ServerEndpoint.Builder

Enclosing interface:

ServerEndpoint

public abstract static class ServerEndpoint.BuilderBase<BUILDER extends ServerEndpoint.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ServerEndpoint>
extends RestEndpoint.BuilderBase<BUILDER,PROTOTYPE>
implements Prototype.Builder<BUILDER,PROTOTYPE>

Fluent API builder base for ServerEndpoint.

Nested Class Summary

Nested Classes

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

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

RestEndpoint.BuilderBase.RestEndpointImpl

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	clearListener()	Clear existing value of this property.
BUILDER	from(ServerEndpoint prototype)	Update this builder from an existing prototype instance.
BUILDER	from(ServerEndpoint.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<String>	listener()	Listener name (optional).
BUILDER	listener(String listener)	Listener name (optional).
boolean	listenerRequired()	Whether the listener must be defined on the server or not.
BUILDER	listenerRequired(boolean listenerRequired)	Whether the listener must be defined on the server or not.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
protected void	validatePrototype()	Validates required properties.

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

addMethod, addMethod, addMethods, from, from, methods, methods

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

addComputedHeader, addComputedHeaders, addConsume, addConsumes, addHeader, addHeaders, addProduce, addProduces, clearPath, 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, 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(ServerEndpoint 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(ServerEndpoint.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

clearListener

public BUILDER clearListener()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• listener()

listener

public BUILDER listener(String listener)

Listener name (optional).

Parameters:

listener - listener this endpoint should be assigned to

Returns:

updated builder instance

See Also:

• listener()

listenerRequired

public BUILDER listenerRequired(boolean listenerRequired)

Whether the listener must be defined on the server or not. If required, server will fail to start if the listener is not configured.

Parameters:

listenerRequired - whether the listener is required, defaults to false

Returns:

updated builder instance

See Also:

• listenerRequired()

listener

public Optional<String> listener()

Listener name (optional).

Returns:

the listener

listenerRequired

public boolean listenerRequired()

Whether the listener must be defined on the server or not. If required, server will fail to start if the listener is not configured.

Returns:

the listener required

toString

public String toString()

Overrides:

toString in class RestEndpoint.BuilderBase<BUILDER extends ServerEndpoint.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ServerEndpoint>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class RestEndpoint.BuilderBase<BUILDER extends ServerEndpoint.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ServerEndpoint>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class RestEndpoint.BuilderBase<BUILDER extends ServerEndpoint.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ServerEndpoint>