Module io.helidon.common

Package io.helidon.common

Interface Builder<B extends Builder<B,T>,T>

Type Parameters:

B - Type of the builder

T - Type of the built instance

All Superinterfaces:

Supplier<T>

All Known Subinterfaces:

BaseMetricsSettings.Builder, ComponentMetricsSettings.Builder, Config.Builder, ConfigNode.ListNode.Builder, DbClientProviderBuilder<T>, HttpRouting.Builder, KeyPerformanceIndicatorMetricsSettings.Builder, MetricsSettings.Builder, OpenTracingTracerBuilder<T>, RegistryFilterSettings.Builder, RegistrySettings.Builder, ResponseBuilder<B,T,X>, RestServiceSettings.Builder, RestServiceSettings.Builder, Router.Builder, Router.Builder, Span.Builder<B>, TracerBuilder<T>

All Known Implementing Classes:

AbacProvider.Builder, AbstractLogEntry.Builder, AbstractLogEntry.Builder, AccessLogFeature.Builder, AccessLogSupport.Builder, AllowList.Builder, AnnotationAnalyzer.AnalyzerResponse.Builder, ApiEntityResponse.Builder, ApiOptionalResponse.Builder, ApiOptionalResponse.BuilderBase, ApiResponse.Builder, AppRoleVaultAuth.Builder, AqConfigBuilder, AqConnector.AqConnectorBuilder, AsymmetricCipher.Builder, Async.Builder, Async.Builder, AuthenticationResponse.Builder, AuthorizationResponse.Builder, BufferedEmittingPublisher.Builder, Bulkhead.Builder, Bulkhead.Builder, Channel.Builder, CircuitBreaker.Builder, CircuitBreaker.Builder, ClasspathConfigSource.Builder, ClasspathOverrideSource.Builder, ClientMethodDescriptor.Builder, ClientServiceDescriptor.Builder, ComponentTracingConfig.Builder, CompositeProviderSelectionPolicy.Builder, ConfigContent.NodeContent.Builder, ConfigContent.OverrideContent.Builder, ConfigParser.Content.Builder, ConfigSources.SystemPropertiesConfigSource.Builder, ConfigVaultProvider.Builder, ConnectionFlowControl.ConnectionFlowControlBuilder, ConnectionPool.Builder, ConnectorConfigBuilder, ContentDisposition.Builder, ContentEncodingContext.Builder, Context.Builder, CorsSupport.Builder, CorsSupport.Builder, CorsSupportBase.Builder, CorsSupportHelper.Builder, CrossOriginConfig.Builder, CubbyholeSecurityProvider.CubbyholeSecretConfig.Builder, DbClient.Builder, DbClientContext.Builder, DbClientHealthCheck.Builder, DbClientMetricBuilder, DbClientTracing.Builder, DbMapperManager.Builder, DbStatementContext.Builder, DbStatements.Builder, DefaultAnnotationAndValue.Builder, DefaultMediaSupport.Builder, DefaultQualifierAndValue.Builder, DefaultTypeInfo.Builder, DefaultTypeName.Builder, DirectHandler.TransportResponse.Builder, DirectHandlers.Builder, DirectoryConfigSource.Builder, DiskSpaceHealthCheck.Builder, EmbeddedStorageManagerBuilder, Emitter.Builder, EncryptedJwt.Builder, EndpointConfig.Builder, EtcdConfigSourceBuilder, EvictableCache.Builder, Fallback.Builder, Fallback.Builder, FaultTolerance.Builder, FaultTolerance.Builder, FaultTolerance.TypedBuilder, FaultTolerance.TypedBuilder, FileConfigSource.Builder, FileFormParams.Builder, FileOverrideSource.Builder, FileSystemWatcher.Builder, GitConfigSourceBuilder, GoogleTokenProvider.Builder, Grant.Builder, GraphQlService.Builder, GraphQlSupport.Builder, GrpcChannelDescriptor.Builder, GrpcChannelsProvider.Builder, GrpcClientSecurity.Builder, GrpcProxyBuilder, GrpcRouting.Builder, GrpcRouting.Builder, GrpcServer.Builder, GrpcServerConfiguration.Builder, GrpcServiceBuilder, GrpcTlsDescriptor.Builder, HashDigest.Builder, HeaderAtnOutboundConfig.Builder, HeaderAtnProvider.Builder, HeaderLogEntry.Builder, HeaderLogEntry.Builder, HealthCheckResponse.Builder, HealthFeature.Builder, HealthSupport.Builder, HeapMemoryHealthCheck.Builder, HelidonFeatureSupport.Builder, HelidonRestServiceSupport.Builder, HelidonServiceLoader.Builder, HmacDigest.Builder, HoconConfigParserBuilder, HostLogEntry.Builder, HostLogEntry.Builder, Http1Client.Http1ClientBuilder, Http1ConnectionProvider.Builder, Http2Client.Http2ClientBuilder, Http2ConnectionProvider.Builder, Http2Settings.Builder, Http2UpgradeProvider.Builder, HttpBasicAuthProvider.Builder, HttpBasicOutboundConfig.Builder, HttpDigestAuthProvider.Builder, HttpMediaType.Builder, HttpRoute.Builder, HttpSignProvider.Builder, IdcsMtRoleMapperProvider.Builder, IdcsMtRoleMapperRxProvider.Builder, IdcsRoleMapperProvider.Builder, IdcsRoleMapperRxProvider.Builder, InboundClientDefinition.Builder, InjectionProvider.InstanceConfig.Builder, InMemoryOverrideSource.Builder, InvocationHandler.Builder, IoMulti.MultiFromByteChannelBuilder, IoMulti.MultiFromInputStreamBuilder, IoMulti.MultiToByteChannelBuilder, IoMulti.OutputStreamMultiBuilder, JaegerTracerBuilder, JavaxElPolicyExecutor.Builder, JdbcDbClientProviderBuilder, JerseySecurityFeature.Builder, JerseySupport.Builder, JmsConfigBuilder, JmsConnector.JmsConnectorBuilder, JmsMessage.OutgoingJmsMessageBuilder, JsonpSupport.Builder, JwkEC.Builder, JwkKeys.Builder, JwkOctet.Builder, JwkRSA.Builder, Jwt.Builder, JwtAuthProvider.Builder, JwtHeaders.Builder, JwtProvider.Builder, JwtProvider.JwtOutboundTarget.Builder, K8sVaultAuth.Builder, KafkaConfigBuilder, KafkaPublisher.Builder, KafkaSubscriber.Builder, KeyConfig.Builder, KeyConfig.KeystoreBuilder, KeyConfig.PemBuilder, Kv1SecurityProvider.Kv1SecretConfig.Builder, Kv2SecurityProvider.Kv2SecretConfig.Builder, ListenerConfiguration.Builder, ListNodeBuilderImpl, LruCache.Builder, MapConfigSource.Builder, MapConfigSource.MapBuilder, MappedCrossOriginConfig.Builder, MapperManager.Builder, MediaContext.Builder, MediaContext.Builder, Messaging.Builder, MeterRegistryFactory.Builder, MetricsFeature.Builder, MetricsSupport.Builder, MicrometerFeature.Builder, MicrometerSupport.Builder, MicrostreamCacheConfigurationBuilder, MicrostreamHealthCheck.Builder, MicrostreamMetricsSupport.Builder, MongoDbClientProviderBuilder, MPOpenAPIBuilder, MultiTappedPublisher.Builder, Neo4j.Builder, Neo4jMetricsSupport.Builder, ObserveFeature.Builder, OciMetricsSupport.Builder, OidcConfig.Builder, OidcFeature.Builder, OidcProvider.Builder, OidcSupport.Builder, OpenApiService.AbstractBuilder, OpenApiService.Builder, OpenAPISupport.Builder, OutboundConfig.Builder, OutboundSecurityClientBuilder, OutboundSecurityResponse.Builder, OutboundTarget.Builder, OutboundTargetDefinition.Builder, Parameters.Builder, PathTracingConfig.Builder, PathTracingConfig.Builder, PolicyValidator.Builder, PolicyValidator.PolicyConfig.Builder, PollingStrategies.ScheduledBuilder, Principal.Builder, PrometheusSupport.Builder, Proxy.Builder, ReadableBodyPart.Builder, ReadableBodyPartHeaders.Builder, RequestedUriDiscoveryContext.Builder, RequestException.Builder, RequestLineLogEntry.Builder, RequestLineLogEntry.Builder, ResolutionContext.Builder, RestApi.Builder, RestException.Builder, Retry.Builder, Retry.Builder, Retry.DelayingRetryPolicy.Builder, Retry.DelayingRetryPolicy.Builder, Retry.JitterRetryPolicy.Builder, Retry.JitterRetryPolicy.Builder, Role.Builder, RoleValidator.RoleConfig.Builder, Routing.Builder, ScheduledPollingStrategy.Builder, ScheduledThreadPoolSupplier.Builder, Scheduling.CronBuilder, Scheduling.FixedRateBuilder, ScopeValidator.Builder, Security.Builder, SecurityClientBuilder, SecurityContext.Builder, SecurityEnvironment.Builder, SecurityLevel.SecurityLevelBuilder, SecurityTime.Builder, SerializationConfig.Builder, Server.Builder, ServerConfiguration.Builder, ServiceDescriptor.Builder, SetCookie.Builder, Signature.Builder, SignedHeadersConfig.Builder, SimpleRetryPolicy.Builder, SizeLogEntry.Builder, SizeLogEntry.Builder, SocketConfiguration.Builder, SocketOptions.Builder, SpanLogTracingConfig.Builder, SpanTracingConfig.Builder, SseEvent.Builder, SSLContextBuilder, StaticContentService.Builder, StaticContentService.ClassPathBuilder, StaticContentService.FileBasedBuilder, StaticContentService.FileSystemBuilder, StaticContentSupport.Builder, StaticContentSupport.ClassPathBuilder, StaticContentSupport.FileBasedBuilder, StaticContentSupport.FileSystemBuilder, StatusLogEntry.Builder, StatusLogEntry.Builder, Subject.Builder, SymmetricCipher.Builder, TenantConfig.Builder, ThreadPoolSupplier.Builder, Timeout.Builder, Timeout.Builder, TimestampLogEntry.Builder, TimestampLogEntry.Builder, TimeTakenLogEntry.Builder, TimeTakenLogEntry.Builder, TimeValidator.TimeConfig.Builder, Tls.Builder, TokenCredential.Builder, TokenHandler.Builder, TokenVaultAuth.Builder, TracingConfig.Builder, TracingFeature.Builder, TransitSecurityProvider.TransitDigestConfig.Builder, TransitSecurityProvider.TransitEncryptionConfig.Builder, TyrusRouting.Builder, TyrusUpgradeProvider.Builder, UrlConfigSource.Builder, UrlOverrideSource.Builder, UserLogEntry.Builder, UserLogEntry.Builder, Vault.Builder, VaultOptionalResponse.Builder, VaultOptionalResponse.BuilderBase, VaultRestApi.Builder, VaultRestApi.BuilderBase, VaultRestException.Builder, VaultToken.Builder, VaultTokenBase.Builder, WebClient.Builder, WebClient.Builder, WebClientTls.Builder, WebServer.Builder, WebServer.Builder, WebServerTls.Builder, WebSocketRouting.Builder, WebTracingConfig.Builder, WriteableBodyPart.Builder, WriteableBodyPartHeaders.Builder, WriteableMultiPart.Builder, WriteableMultiPart.Builder, WriteablePart.Builder, WsClient.Builder, WsRouting.Builder, WsUpgradeProvider.AbstractBuilder, WsUpgradeProvider.Builder, ZipkinTracerBuilder

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Builder<B extends Builder<B,T>,T>
extends Supplier<T>

Interface for builders, to be able to accept a builder in addition to an instance.

This interface is similar to Supplier as it provides an instance, only for classes that act as instance builders (fluent API builder pattern), where method Supplier.get() would be misleading.

Method Summary

Modifier and Type	Method	Description
T	build()	Build the instance from this builder.
default T	get()
default B	identity()	Instance of this builder as the correct type.
default B	update(Consumer<B> consumer)	Update the builder in a fluent API way.

Method Details

build

T build()

Build the instance from this builder.

Returns:

instance of the built type

update

default B update(Consumer<B> consumer)

Update the builder in a fluent API way.

Parameters:

consumer - consumer of the builder instance

Returns:

updated builder instance

identity

default B identity()

Instance of this builder as the correct type.

Returns:

this instance typed to correct type

get

default T get()

Specified by:

get in interface Supplier<B extends Builder<B,T>>