Module io.helidon.declarative.codegen.model

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

Interface HttpAnnotated

All Superinterfaces:

ModelElement, Prototype.Api

All Known Subinterfaces:

ClientEndpoint, RestEndpoint, RestMethod, ServerEndpoint

All Known Implementing Classes:

ClientEndpoint.BuilderBase.ClientEndpointImpl, HttpAnnotated.BuilderBase.HttpAnnotatedImpl, RestEndpoint.BuilderBase.RestEndpointImpl, RestMethod.BuilderBase.RestMethodImpl, ServerEndpoint.BuilderBase.ServerEndpointImpl

public interface HttpAnnotated
extends Prototype.Api, ModelElement

An element that is annotation within the HTTP REST handling.

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HttpAnnotated.Builder	Fluent API builder for HttpAnnotated.
static class	HttpAnnotated.BuilderBase<BUILDER extends HttpAnnotated.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HttpAnnotated>	Fluent API builder base for HttpAnnotated.

Method Summary

Modifier and Type	Method	Description
static HttpAnnotated.Builder	builder()	Create a new fluent API builder to customize configuration.
static HttpAnnotated.Builder	builder(HttpAnnotated instance)	Create a new fluent API builder from an existing instance.
List<ComputedHeader>	computedHeaders()	List of computed header values.
List<String>	consumes()	List of consumed media types (from server endpoint point of view).
List<HeaderValue>	headers()	List of configured header values.
Optional<String>	path()	Path of the endpoint/method (optional).
List<String>	produces()	List of produced media types (from server endpoint point of view).

Methods inherited from interface io.helidon.declarative.codegen.model.http.ModelElement

annotations, type

Method Details

builder

static HttpAnnotated.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static HttpAnnotated.Builder builder(HttpAnnotated instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

produces

List<String> produces()

List of produced media types (from server endpoint point of view).

Returns:

media types

consumes

List<String> consumes()

List of consumed media types (from server endpoint point of view).

Returns:

media types

headers

List<HeaderValue> headers()

List of configured header values.

Returns:

header values

computedHeaders

List<ComputedHeader> computedHeaders()

List of computed header values.

Returns:

computed header values

path

Optional<String> path()

Path of the endpoint/method (optional).

Returns:

endpoint/method path