cn.crane4j.core.container

接口 ContainerManager

所有超级接口:

ConfigurableContainerProvider, ContainerProvider

所有已知子接口:

Crane4jGlobalConfiguration

所有已知实现类:

DefaultContainerManager, SimpleCrane4jGlobalConfiguration

public interface ContainerManager
extends ConfigurableContainerProvider

The central interface used for managing the container and its lifecycle-related components.

从以下版本开始:

1.3.0

作者:

huangchengxing

另请参阅:

ContainerLifecycleProcessor, ContainerDefinition

字段概要

字段

限定符和类型	字段和说明
static String	PROVIDER_NAME_PREFIX Prefix of namespace which create by container provider.

方法概要

限定符和类型	方法和说明
static String	canonicalNamespace(String namespace, @Nullable String providerName) Canonicalize namespace.
void	clear() Clear all data caches.
Collection<Container<Object>>	getAllLimitedContainers() Get all limited containers.
<K> @Nullable Container<K>	getContainer(String namespace) Obtaining and caching container instances from provider or definition.
default <K> @Nullable Container<K>	getContainer(String providerName, String namespace) Obtaining and caching container instances from the specified container provider.
Collection<ContainerLifecycleProcessor>	getContainerLifecycleProcessors() Get all registered ContainerLifecycleProcessor.
<T extends ContainerProvider> T	getContainerProvider(String name) Get ContainerProvider by given name.
default ContainerDefinition	registerContainer(@NonNull Container<?> container) Register container definition by given container instance.
ContainerDefinition	registerContainer(ContainerDefinition definition) Register container definition.
default ContainerDefinition	registerContainer(String namespace, Supplier<Container<Object>> factory) Register container definition by given arguments.
boolean	registerContainerLifecycleProcessor(ContainerLifecycleProcessor lifecycle) Register ContainerLifecycleProcessor.
void	registerContainerProvider(String name, ContainerProvider containerProvider) Register ContainerProvider by given name.

从接口继承的方法 cn.crane4j.core.container.ContainerProvider

containsContainer

字段详细资料

PROVIDER_NAME_PREFIX

static final String PROVIDER_NAME_PREFIX

Prefix of namespace which create by container provider. for example:
getContainer("namespace&&providerName") is equivalent to getContainer("namespace", "providerName")

另请参阅:

getContainer(String), getContainer(String, String), 常量字段值

方法详细资料

canonicalNamespace

static String canonicalNamespace(String namespace,
                                 @Nullable String providerName)

Canonicalize namespace.

参数:

namespace - namespace

providerName - provider name

返回:

container

clear

void clear()

Clear all data caches.

另请参阅:

ContainerLifecycleProcessor.whenRegistered(java.lang.Object, cn.crane4j.core.container.ContainerDefinition)

registerContainerLifecycleProcessor

boolean registerContainerLifecycleProcessor(ContainerLifecycleProcessor lifecycle)

Register ContainerLifecycleProcessor.

参数:

lifecycle - lifecycle

返回:

whether the registration is successful

getContainerLifecycleProcessors

Collection<ContainerLifecycleProcessor> getContainerLifecycleProcessors()

Get all registered ContainerLifecycleProcessor.

返回:

ContainerLifecycleProcessor

registerContainerProvider

void registerContainerProvider(String name,
                               ContainerProvider containerProvider)

Register ContainerProvider by given name.

参数:

name - name

containerProvider - containerProvider

getContainerProvider

<T extends ContainerProvider> T getContainerProvider(String name)

Get ContainerProvider by given name.

参数:

name - name

返回:

ContainerProvider instance

registerContainer

ContainerDefinition registerContainer(ContainerDefinition definition)

Register container definition.
This operation will overwrite the existing container definition.

参数:

definition - definition of container

返回:

container definition currently registered with the manager

另请参阅:

ContainerLifecycleProcessor.whenRegistered(java.lang.Object, cn.crane4j.core.container.ContainerDefinition)

registerContainer

default ContainerDefinition registerContainer(String namespace,
                                              Supplier<Container<Object>> factory)

Register container definition by given arguments.
This operation will overwrite the existing container definition.

参数:

namespace - namespace of container

factory - factory method of container instance

返回:

container definition currently registered with the manager

另请参阅:

ContainerLifecycleProcessor.whenRegistered(java.lang.Object, cn.crane4j.core.container.ContainerDefinition)

registerContainer

default ContainerDefinition registerContainer(@NonNull Container<?> container)

Register container definition by given container instance.
This operation will overwrite the existing container definition.

指定者:

registerContainer 在接口中 ConfigurableContainerProvider

参数:

container - container

返回:

container definition currently registered with the manager

另请参阅:

ContainerLifecycleProcessor.whenRegistered(java.lang.Object, cn.crane4j.core.container.ContainerDefinition)

getContainer

<K> @Nullable Container<K> getContainer(String namespace)

Obtaining and caching container instances from provider or definition.

指定者:

getContainer 在接口中 ContainerProvider

类型参数:

K - key type

参数:

namespace - namespace of container, which can also be the cache name for the container instance.

返回:

container instance

另请参阅:

ContainerLifecycleProcessor.whenCreated(cn.crane4j.core.container.ContainerDefinition, cn.crane4j.core.container.Container<java.lang.Object>)

getAllLimitedContainers

Collection<Container<Object>> getAllLimitedContainers()

Get all limited containers.

返回:

limited containers

从以下版本开始:

2.3.0

getContainer

default <K> @Nullable Container<K> getContainer(String providerName,
                                                String namespace)

Obtaining and caching container instances from the specified container provider.

类型参数:

K - key type

参数:

providerName - container provider name

namespace - namespace of container

返回:

container provider

另请参阅:

ContainerLifecycleProcessor.whenCreated(cn.crane4j.core.container.ContainerDefinition, cn.crane4j.core.container.Container<java.lang.Object>)