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

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

java.lang.Object
io.helidon.declarative.codegen.model.http.ModelElement.BuilderBase<BUILDER,PROTOTYPE>
io.helidon.declarative.codegen.model.http.HttpAnnotated.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:
HttpAnnotated.Builder, RestEndpoint.BuilderBase, RestMethod.BuilderBase
Enclosing interface:
HttpAnnotated
public abstract static class HttpAnnotated.BuilderBase<BUILDER extends HttpAnnotated.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HttpAnnotated> extends ModelElement.BuilderBase<BUILDER,PROTOTYPE> implements Prototype.Builder<BUILDER,PROTOTYPE>
Fluent API builder base for HttpAnnotated.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(HttpAnnotated 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(HttpAnnotated.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

    • clearProduces

      public BUILDER clearProduces()
      Clear all produces.
      Returns:
      updated builder instance
      See Also:

    • produces

      public BUILDER produces(List<String> produces)
      List of produced media types (from server endpoint point of view).
      Parameters:
      produces - media types
      Returns:
      updated builder instance
      See Also:

    • addProduces

      public BUILDER addProduces(List<String> produces)
      List of produced media types (from server endpoint point of view).
      Parameters:
      produces - media types
      Returns:
      updated builder instance
      See Also:

    • addProduce

      public BUILDER addProduce(String produce)
      List of produced media types (from server endpoint point of view).
      Parameters:
      produce - add single media types
      Returns:
      updated builder instance
      See Also:

    • clearConsumes

      public BUILDER clearConsumes()
      Clear all consumes.
      Returns:
      updated builder instance
      See Also:

    • consumes

      public BUILDER consumes(List<String> consumes)
      List of consumed media types (from server endpoint point of view).
      Parameters:
      consumes - media types
      Returns:
      updated builder instance
      See Also:

    • addConsumes

      public BUILDER addConsumes(List<String> consumes)
      List of consumed media types (from server endpoint point of view).
      Parameters:
      consumes - media types
      Returns:
      updated builder instance
      See Also:

    • addConsume

      public BUILDER addConsume(String consume)
      List of consumed media types (from server endpoint point of view).
      Parameters:
      consume - add single media types
      Returns:
      updated builder instance
      See Also:

    • clearHeaders

      public BUILDER clearHeaders()
      Clear all headers.
      Returns:
      updated builder instance
      See Also:

    • headers

      public BUILDER headers(List<? extends HeaderValue> headers)
      List of configured header values.
      Parameters:
      headers - header values
      Returns:
      updated builder instance
      See Also:

    • addHeaders

      public BUILDER addHeaders(List<? extends HeaderValue> headers)
      List of configured header values.
      Parameters:
      headers - header values
      Returns:
      updated builder instance
      See Also:

    • addHeader

      public BUILDER addHeader(HeaderValue header)
      List of configured header values.
      Parameters:
      header - add single header values
      Returns:
      updated builder instance
      See Also:

    • clearComputedHeaders

      public BUILDER clearComputedHeaders()
      Clear all computedHeaders.
      Returns:
      updated builder instance
      See Also:

    • computedHeaders

      public BUILDER computedHeaders(List<? extends ComputedHeader> computedHeaders)
      List of computed header values.
      Parameters:
      computedHeaders - computed header values
      Returns:
      updated builder instance
      See Also:

    • addComputedHeaders

      public BUILDER addComputedHeaders(List<? extends ComputedHeader> computedHeaders)
      List of computed header values.
      Parameters:
      computedHeaders - computed header values
      Returns:
      updated builder instance
      See Also:

    • addComputedHeader

      public BUILDER addComputedHeader(ComputedHeader computedHeader)
      List of computed header values.
      Parameters:
      computedHeader - add single computed header values
      Returns:
      updated builder instance
      See Also:

    • clearPath

      public BUILDER clearPath()
      Clear existing value of path.
      Returns:
      updated builder instance
      See Also:

    • path

      public BUILDER path(String path)
      Path of the endpoint/method (optional).
      Parameters:
      path - endpoint/method path
      Returns:
      updated builder instance
      See Also:

    • produces

      public List<String> produces()
      List of produced media types (from server endpoint point of view).
      Returns:
      media types

    • consumes

      public List<String> consumes()
      List of consumed media types (from server endpoint point of view).
      Returns:
      media types

    • headers

      public List<HeaderValue> headers()
      List of configured header values.
      Returns:
      header values

    • computedHeaders

      public List<ComputedHeader> computedHeaders()
      List of computed header values.
      Returns:
      computed header values

    • path

      public Optional<String> path()
      Path of the endpoint/method (optional).
      Returns:
      endpoint/method path

    • toString

      public String toString()
      Overrides:
      toString in class ModelElement.BuilderBase<BUILDER extends HttpAnnotated.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HttpAnnotated>

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.
      Overrides:
      preBuildPrototype in class ModelElement.BuilderBase<BUILDER extends HttpAnnotated.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HttpAnnotated>

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.
      Overrides:
      validatePrototype in class ModelElement.BuilderBase<BUILDER extends HttpAnnotated.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HttpAnnotated>