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 RestEndpoint.BuilderBase
RestEndpoint.BuilderBase.RestEndpointImplModifier and TypeClassDescriptionprotected static classGenerated implementation of the prototype, can be extended by descendant prototype implementations.Nested classes/interfaces inherited from class HttpAnnotated.BuilderBase
HttpAnnotated.BuilderBase.HttpAnnotatedImplModifier and TypeClassDescriptionprotected static classGenerated implementation of the prototype, can be extended by descendant prototype implementations.Nested classes/interfaces inherited from class ModelElement.BuilderBase
ModelElement.BuilderBase.ModelElementImplModifier and TypeClassDescriptionprotected static classGenerated implementation of the prototype, can be extended by descendant prototype implementations. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionClear existing value of listener.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 RestEndpoint.BuilderBase
addMethod, addMethod, addMethods, clearMethods, from, from, methods, methodsModifier and TypeMethodDescriptionaddMethod(RestMethod method) Methods that have a rest annotation (HTTP method).addMethod(Consumer<RestMethod.Builder> consumer) Methods that have a rest annotation (HTTP method).addMethods(List<? extends RestMethod> methods) Methods that have a rest annotation (HTTP method).Clear all methods.from(RestEndpoint prototype) Update this builder from an existing prototype instance.from(RestEndpoint.BuilderBase<?, ?> builder) Update this builder from an existing prototype builder instance.methods()Methods that have a rest annotation (HTTP method).methods(List<? extends RestMethod> methods) Methods that have a rest annotation (HTTP method).Methods inherited from class 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, producesModifier and TypeMethodDescriptionaddComputedHeader(ComputedHeader computedHeader) List of computed header values.addComputedHeaders(List<? extends ComputedHeader> computedHeaders) List of computed header values.addConsume(String consume) List of consumed media types (from server endpoint point of view).addConsumes(List<String> consumes) List of consumed media types (from server endpoint point of view).addHeader(HeaderValue header) List of configured header values.addHeaders(List<? extends HeaderValue> headers) List of configured header values.addProduce(String produce) List of produced media types (from server endpoint point of view).addProduces(List<String> produces) List of produced media types (from server endpoint point of view).Clear all computedHeaders.Clear all consumes.Clear all headers.Clear existing value of path.Clear all produces.List of computed header values.computedHeaders(List<? extends ComputedHeader> computedHeaders) List of computed header values.consumes()List of consumed media types (from server endpoint point of view).List of consumed media types (from server endpoint point of view).from(HttpAnnotated prototype) Update this builder from an existing prototype instance.from(HttpAnnotated.BuilderBase<?, ?> builder) Update this builder from an existing prototype builder instance.headers()List of configured header values.headers(List<? extends HeaderValue> headers) List of configured header values.path()Path of the endpoint/method (optional).Path of the endpoint/method (optional).produces()List of produced media types (from server endpoint point of view).List of produced media types (from server endpoint point of view).Methods inherited from class ModelElement.BuilderBase
addAnnotation, addAnnotation, addAnnotations, annotations, annotations, clearAnnotations, from, from, type, type, type, typeModifier and TypeMethodDescriptionaddAnnotation(Annotation annotation) All annotations on this element, and inherited from supertype/interface and annotations.addAnnotation(Consumer<Annotation.Builder> consumer) All annotations on this element, and inherited from supertype/interface and annotations.addAnnotations(Set<? extends Annotation> annotations) All annotations on this element, and inherited from supertype/interface and annotations.All annotations on this element, and inherited from supertype/interface and annotations.annotations(Set<? extends Annotation> annotations) All annotations on this element, and inherited from supertype/interface and annotations.Clear all annotations.from(ModelElement prototype) Update this builder from an existing prototype instance.from(ModelElement.BuilderBase<?, ?> builder) Update this builder from an existing prototype builder instance.type()Type of this element.Type of this element.type(Consumer<TypeInfo.Builder> consumer) Type of this element.Type of this element.Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface 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 listener.- Returns:
- updated builder instance
- See Also:
-
listener
-
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
-
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:
- whether the listener is required, defaults to
false
-
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>
-