Package net.ygbstudio.jbrave.core.builders

Class AbstractBraveRequestBuilder<T extends AbstractBraveRequestBuilder<T>>

java.lang.Object
net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder<T>
Type Parameters:
T - The concrete builder class.
Direct Known Subclasses:
BraveVerticalSearchRequest, BraveWebSearchRequest
public abstract class AbstractBraveRequestBuilder<T extends AbstractBraveRequestBuilder<T>> extends Object
Abstract base class for building Brave API request builders.

This class is the base class for all Brave API request builders. It provides the basic functionality to build requests, such as adding headers to the request and building the request itself.

Note: This builder enforces strict request invariants. Subclasses must not override core lifecycle methods. Extension is intended via additional fluent APIs only.

  • Field Details

    • headers

      protected Set<BraveSearchHeader> headers
      Headers accumulated for the request before they are attached.

    • internalRequestBuilder

      protected HttpRequest.Builder internalRequestBuilder
      The underlying HTTP request builder.

    • requestURI

      protected URI requestURI
      The request URI, retained by clearRetainURI().

    • headersAttached

      protected boolean headersAttached
      Whether the accumulated headers have already been attached to the request.

  • Constructor Details

    • AbstractBraveRequestBuilder

      public AbstractBraveRequestBuilder()
      Creates a new abstract request builder with an empty request state.

      Concrete subclasses must call clear() to initialize the builder before use.

  • Method Details

    • self

      protected final T self()
      Returns the current instance of the builder.

      The cast is safe because subclasses follow the self-referential generic pattern used by this base class.

      Returns:
      Current instance of the builder.

    • queryURI

      protected final T queryURI(URI query)
      Sets the URI for the request.
      Parameters:
      query - the URI for the request
      Returns:
      the current builder instance

    • addHeader

      protected final <K extends SearchHeader> T addHeader(@NotNull K header, String value)
      Adds a header to the list of headers.
      Type Parameters:
      K - the type of the header, which must extend SearchHeader
      Parameters:
      header - the header to be added
      value - the value of the header
      Returns:
      the current builder instance

    • attachHeaders

      protected final void attachHeaders()
      Attaches the headers to the request builder.

    • subscriptionMissing

      protected final boolean subscriptionMissing()
      Checks if the subscription token header is missing.
      Returns:
      true if the subscription token header is missing, false otherwise.

    • clear

      public final T clear()
      Clears the request builder, resetting it to its initial state.
      Returns:
      the current builder instance

    • clearRetainURI

      public final T clearRetainURI()
      Clears the request builder, resetting it to its initial state while retaining the currently set URI.
      Returns:
      the current builder instance

    • build

      public final HttpRequest build()
      Builds the request using the current state of the builder.

      This method attaches the headers to the request builder and throws a MissingSubscriptionTokenException if the subscription token header is missing.

      Returns:
      the built HttpRequest
      Throws:
      MissingSubscriptionTokenException - if the subscription token header is missing