Module io.helidon.http.media
Package io.helidon.http.media

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

java.lang.Object
io.helidon.http.media.MediaContextConfig.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>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
MediaContextConfig.Builder
Enclosing interface:
MediaContextConfig
public abstract static class MediaContextConfig.BuilderBase<BUILDER extends MediaContextConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MediaContextConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for MediaContextConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

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

    • config

      @Deprecated public BUILDER config(Config config)
      Deprecated.
      use config(io.helidon.config.Config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends MediaContextConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MediaContextConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • config

      public BUILDER config(Config config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends MediaContextConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MediaContextConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • clearMediaSupports

      public BUILDER clearMediaSupports()
      Clear all mediaSupports.
      Returns:
      updated builder instance
      See Also:

    • mediaSupports

      public BUILDER mediaSupports(List<? extends MediaSupport> mediaSupports)
      Media supports to use. This instance has priority over provider(s) discovered by service loader. The providers are used in order of calling this method, where the first support added is the first one to be queried for readers and writers.
      Parameters:
      mediaSupports - media supports
      Returns:
      updated builder instance
      See Also:

    • addMediaSupports

      public BUILDER addMediaSupports(List<? extends MediaSupport> mediaSupports)
      Media supports to use. This instance has priority over provider(s) discovered by service loader. The providers are used in order of calling this method, where the first support added is the first one to be queried for readers and writers.
      Parameters:
      mediaSupports - media supports
      Returns:
      updated builder instance
      See Also:

    • addMediaSupport

      public BUILDER addMediaSupport(MediaSupport mediaSupport)
      Media supports to use. This instance has priority over provider(s) discovered by service loader. The providers are used in order of calling this method, where the first support added is the first one to be queried for readers and writers.
      Parameters:
      mediaSupport - add single media supports
      Returns:
      updated builder instance
      See Also:

    • clearFallback

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

    • fallback

      public BUILDER fallback(MediaContext fallback)
      Existing context to be used as a fallback for this context.
      Parameters:
      fallback - media context to use if supports configured on this request cannot provide a good result
      Returns:
      updated builder instance
      See Also:

    • fallback

      public BUILDER fallback(MediaContextConfig fallback)
      Existing context to be used as a fallback for this context.
      Parameters:
      fallback - prototype of media context to use if supports configured on this request cannot provide a good result
      Returns:
      updated builder instance
      See Also:

    • fallback

      public BUILDER fallback(Consumer<MediaContextConfig.Builder> consumer)
      Existing context to be used as a fallback for this context.
      Parameters:
      consumer - consumer of builder of media context to use if supports configured on this request cannot provide a good result
      Returns:
      updated builder instance
      See Also:

    • registerDefaults

      public BUILDER registerDefaults(boolean registerDefaults)
      Should we register defaults of Helidon, such as String media support.
      Parameters:
      registerDefaults - whether to register default media supports
      Returns:
      updated builder instance
      See Also:

    • mediaSupportsDiscoverServices

      public BUILDER mediaSupportsDiscoverServices(boolean mediaSupportsDiscoverServices)
      Service discovery flag for mediaSupports(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Parameters:
      mediaSupportsDiscoverServices - whether to enable automatic service discovery
      Returns:
      updated builder instance
      See Also:

    • mediaSupports

      public List<MediaSupport> mediaSupports()
      Media supports to use. This instance has priority over provider(s) discovered by service loader. The providers are used in order of calling this method, where the first support added is the first one to be queried for readers and writers.
      Returns:
      media supports

    • fallback

      public Optional<MediaContext> fallback()
      Existing context to be used as a fallback for this context.
      Returns:
      media context to use if supports configured on this request cannot provide a good result

    • registerDefaults

      public boolean registerDefaults()
      Should we register defaults of Helidon, such as String media support.
      Returns:
      whether to register default media supports

    • mediaSupportsDiscoverServices

      public boolean mediaSupportsDiscoverServices()
      Service discovery flag for mediaSupports(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Returns:
      whether to enable automatic service discovery

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.

    • config

      protected Optional<Config> config()
      Configuration used to configure this instance.
      Returns:
      config instance