Module io.helidon.webserver.staticcontent

Package io.helidon.webserver.staticcontent

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

java.lang.Object

io.helidon.webserver.staticcontent.BaseHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.webserver.staticcontent.FileSystemHandlerConfig.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:

FileSystemHandlerConfig.Builder

Enclosing interface:

FileSystemHandlerConfig

public abstract static class FileSystemHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FileSystemHandlerConfig>
extends BaseHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for FileSystemHandlerConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	FileSystemHandlerConfig.BuilderBase.FileSystemHandlerConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class io.helidon.webserver.staticcontent.BaseHandlerConfig.BuilderBase

BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
Optional<Config>	config()	If this instance was configured, this would be the config instance used.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(FileSystemHandlerConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(FileSystemHandlerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<Path>	location()	The directory (or a single file) that contains the root of the static content.
BUILDER	location(Path location)	The directory (or a single file) that contains the root of the static content.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class io.helidon.webserver.staticcontent.BaseHandlerConfig.BuilderBase

addCachedFile, addCachedFiles, addContentTypes, addSocket, addSockets, cachedFiles, cachedFiles, clearMemoryCache, clearRecordCacheCapacity, clearWelcome, contentTypes, contentTypes, context, context, enabled, enabled, from, from, memoryCache, memoryCache, memoryCache, memoryCache, pathMapper, pathMapper, putContentType, recordCacheCapacity, recordCacheCapacity, sockets, sockets, welcome, welcome

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(FileSystemHandlerConfig 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(FileSystemHandlerConfig.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 FileSystemHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FileSystemHandlerConfig>

Overrides:

config in class BaseHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FileSystemHandlerConfig>

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 FileSystemHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FileSystemHandlerConfig>

Overrides:

config in class BaseHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FileSystemHandlerConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

location

public BUILDER location(Path location)

The directory (or a single file) that contains the root of the static content.

Parameters:

location - location to serve the static content, such as "/home/user/static-content".

Returns:

updated builder instance

See Also:

• location()

location

public Optional<Path> location()

The directory (or a single file) that contains the root of the static content.

Returns:

the location

config

public Optional<Config> config()

If this instance was configured, this would be the config instance used.

Overrides:

config in class BaseHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FileSystemHandlerConfig>

Returns:

config node used to configure this builder, or empty if not configured

toString

public String toString()

Overrides:

toString in class BaseHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FileSystemHandlerConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class BaseHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FileSystemHandlerConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class BaseHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FileSystemHandlerConfig>