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 builderPROTOTYPE- type of the prototype interface that would be built byPrototype.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 ClassesModifier and TypeClassDescriptionprotected static classGenerated 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.RestEndpointImplNested classes/interfaces inherited from class io.helidon.declarative.codegen.model.http.HttpAnnotated.BuilderBase
HttpAnnotated.BuilderBase.HttpAnnotatedImplNested classes/interfaces inherited from class io.helidon.declarative.codegen.model.http.ModelElement.BuilderBase
ModelElement.BuilderBase.ModelElementImpl -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionClear existing value of this property.from(ServerEndpoint prototype) Update this builder from an existing prototype instance.from(ServerEndpoint.BuilderBase<?, ?> builder) Update this builder from an existing prototype builder instance.listener()Listener name (optional).Listener name (optional).booleanWhether the listener must be defined on the server or not.listenerRequired(boolean listenerRequired) Whether the listener must be defined on the server or not.protected voidHandles providers and decorators.toString()protected voidValidates required properties.Methods inherited from class io.helidon.declarative.codegen.model.http.RestEndpoint.BuilderBase
addMethod, addMethod, addMethods, from, from, methods, methodsMethods 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, producesMethods inherited from class io.helidon.declarative.codegen.model.http.ModelElement.BuilderBase
addAnnotation, addAnnotation, addAnnotations, annotations, annotations, from, from, type, type, type, typeMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface io.helidon.builder.api.Prototype.Builder
buildPrototype, self
-
Constructor Details
-
BuilderBase
protected BuilderBase()Protected to support extensibility.
-
-
Method Details
-
from
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
Update this builder from an existing prototype builder instance.- Parameters:
builder- existing builder prototype to update this builder from- Returns:
- updated builder instance
-
clearListener
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
listener
Listener name (optional).- Parameters:
listener- listener this endpoint should be assigned to- Returns:
- updated builder instance
- See Also:
-
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 tofalse- Returns:
- updated builder instance
- See Also:
-
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
- Overrides:
toStringin classRestEndpoint.BuilderBase<BUILDER extends ServerEndpoint.BuilderBase<BUILDER,PROTOTYPE>, PROTOTYPE extends ServerEndpoint>
-
preBuildPrototype
protected void preBuildPrototype()Handles providers and decorators.- Overrides:
preBuildPrototypein classRestEndpoint.BuilderBase<BUILDER extends ServerEndpoint.BuilderBase<BUILDER,PROTOTYPE>, PROTOTYPE extends ServerEndpoint>
-
validatePrototype
protected void validatePrototype()Validates required properties.- Overrides:
validatePrototypein classRestEndpoint.BuilderBase<BUILDER extends ServerEndpoint.BuilderBase<BUILDER,PROTOTYPE>, PROTOTYPE extends ServerEndpoint>
-