Package io.activej.types.scanner

Class TypeScannerRegistry<R>

java.lang.Object

io.activej.types.scanner.TypeScannerRegistry<R>

Type Parameters:

R - a type of mapping result

public final class TypeScannerRegistry<R>
extends Object

A registry of TypeScannerRegistry.Mappings by type

Allows traversing complex annotated types

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TypeScannerRegistry.Context<R>	A context that encapsulates a TypeScannerRegistry.Mapping<R> and two stacks (a context stack and an argument stack).
static interface	TypeScannerRegistry.Mapping<R>	An interface that describes how TypeScannerRegistry.Mapping value should be retrieved from a TypeScannerRegistry.Context<R>
static final record	TypeScannerRegistry.MappingEntry<R>

Method Summary

Modifier and Type	Method	Description
static <R> TypeScannerRegistry<R>	copyOf(TypeScannerRegistry<R> registry)
static <R> TypeScannerRegistry<R>	create()	Creates a new TypeScannerRegistry
R	scan(TypeScannerRegistry.Context<R> ctx)	Scans a context and retrieves TypeScannerRegistry value as a result
TypeScanner<R>	scanner()	Creates a new type scanner with no context value
TypeScanner<R>	scanner(@Nullable Object contextValue)	Creates a new type scanner with a context value
TypeScannerRegistry<R>	with(TypeT<?> typeT, TypeScannerRegistry.Mapping<R> fn)	Adds a mapping for a given type
TypeScannerRegistry<R>	with(Type type, TypeScannerRegistry.Mapping<R> fn)	Adds a mapping for a given type
TypeScannerRegistry<R>	withMapping(TypeScannerRegistry.Mapping<R> mappingFn)	Adds a mapping that defines how TypeScannerRegistry value should be retrieved from a TypeScannerRegistry.Context<R>
TypeScannerRegistry<R>	withMapping(BiFunction<TypeScannerRegistry.Mapping<R>,TypeScannerRegistry.Context<R>,R> mappingFn)	Adds a mapping that defines how TypeScannerRegistry value should be retrieved from a TypeScannerRegistry.Context<R> and a mapping that does scan(Context)

Methods inherited from class java.lang.Object

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

Method Details

create

public static <R> TypeScannerRegistry<R> create()

Creates a new TypeScannerRegistry

Type Parameters:

R - type of values to be retrieved from the registry

Returns:

a new instance of TypeScannerRegistry

copyOf

public static <R> TypeScannerRegistry<R> copyOf(TypeScannerRegistry<R> registry)

with

public TypeScannerRegistry<R> with(TypeT<?> typeT,
 TypeScannerRegistry.Mapping<R> fn)

Adds a mapping for a given type

Parameters:

typeT - a type token

fn - a mapping token to be added for a given type

with

public TypeScannerRegistry<R> with(Type type,
 TypeScannerRegistry.Mapping<R> fn)

Adds a mapping for a given type

Parameters:

type - a type

fn - a mapping to be added for a given type

withMapping

public TypeScannerRegistry<R> withMapping(TypeScannerRegistry.Mapping<R> mappingFn)

Adds a mapping that defines how TypeScannerRegistry value should be retrieved from a TypeScannerRegistry.Context<R>

Parameters:

mappingFn - a mapping function

withMapping

public TypeScannerRegistry<R> withMapping(BiFunction<TypeScannerRegistry.Mapping<R>,TypeScannerRegistry.Context<R>,R> mappingFn)

Adds a mapping that defines how TypeScannerRegistry value should be retrieved from a TypeScannerRegistry.Context<R> and a mapping that does scan(Context)

Parameters:

mappingFn - a mapping function

scanner

public TypeScanner<R> scanner()

Creates a new type scanner with no context value

Returns:

a new instance of TypeScanner

scanner

public TypeScanner<R> scanner(@Nullable
 @Nullable Object contextValue)

Creates a new type scanner with a context value

Parameters:

contextValue - a context value of this type scanner, possibly null

Returns:

a new instance of TypeScanner

scan

public R scan(TypeScannerRegistry.Context<R> ctx)

Scans a context and retrieves TypeScannerRegistry value as a result

Parameters:

ctx - a scan context

Returns:

TypeScannerRegistry value retrieved as a result of scan