Class ProteusBuilder

java.lang.Object

io.github.kaktushose.proteus.ProteusBuilder

public final class ProteusBuilder
extends Object

Builder for Proteus instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProteusBuilder.ConflictStrategy	The ProteusBuilder.ConflictStrategy to use if a duplicate path registration happens.
static enum	ProteusBuilder.DefaultMapper	The ProteusBuilder.DefaultMappers to register.

Method Summary

Modifier and Type	Method	Description
@NotNull Proteus	build()	Builds the Proteus instance.
@NotNull ProteusBuilder	cacheSize(int cacheSize)	The cache size to use for the underlying LRU-Cache used for caching conversion paths.
@NotNull ProteusBuilder	conflictStrategy(@NotNull ProteusBuilder.ConflictStrategy conflictStrategy)	The ProteusBuilder.ConflictStrategy to use if a duplicate path registration happens.
@NotNull ProteusBuilder	defaultMappers(ProteusBuilder.DefaultMapper... defaultMappers)	The default mappers to register as described by ProteusBuilder.DefaultMapper.

Methods inherited from class java.lang.Object

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

Method Details

cacheSize

@NotNull
public @NotNull ProteusBuilder cacheSize(int cacheSize)

The cache size to use for the underlying LRU-Cache used for caching conversion paths. The default value is 1000.

Parameters:

cacheSize - cache size to use for the underlying LRU-Cache

Returns:

this instance for fluent interface

defaultMappers

@NotNull
public @NotNull ProteusBuilder defaultMappers(ProteusBuilder.DefaultMapper... defaultMappers)

The default mappers to register as described by ProteusBuilder.DefaultMapper. These default mappers are lossless and follow the widening and narrowing primitive conversion of the Java Language Specification.

Parameters:

defaultMappers - the ProteusBuilder.DefaultMappers to register

Returns:

this instance for fluent interface

See Also:

• Java Language Specification

Implementation Note:

By default, all ProteusBuilder.DefaultMappers will be registered. Can be disabled by calling this method with zero arguments.

conflictStrategy

@NotNull
public @NotNull ProteusBuilder conflictStrategy(@NotNull
 @NotNull ProteusBuilder.ConflictStrategy conflictStrategy)

The ProteusBuilder.ConflictStrategy to use if a duplicate path registration happens. Although, each Type can have n neighbours, but each path can only exist once.

Parameters:

conflictStrategy - the ProteusBuilder.ConflictStrategy to use

Returns:

this instance for fluent interface

build

@NotNull
public @NotNull Proteus build()

Builds the Proteus instance.

Returns:

the Proteus instance