cn.crane4j.core.container

类 EnumContainerBuilder<K,T extends Enum<?>>

java.lang.Object

cn.crane4j.core.container.EnumContainerBuilder<K,T>

类型参数:

K - key type

T - enumeration type

public class EnumContainerBuilder<K,T extends Enum<?>>
extends Object

A builder class for creating Containers from enumerations.

作者:

tangcent

另请参阅:

ContainerEnum

方法概要

限定符和类型	方法和说明
EnumContainerBuilder<K,T>	annotationFinder(@NonNull AnnotationFinder annotationFinder) Sets the annotation finder to use for reading the ContainerEnum annotation.
Container<K>	build() Builds and returns an immutable container from the specified enum type and builder configuration.
EnumContainerBuilder<K,T>	duplicateStrategy(DuplicateStrategy duplicateStrategy) Set processing strategy of when the key is duplicated.
EnumContainerBuilder<K,T>	enableContainerEnumAnnotation(boolean enableContainerEnumAnnotation) Whether to enable resolves configuration from the specified ContainerEnum annotation.
EnumContainerBuilder<Object,T>	key(@NonNull String key) Sets the key to use for obtaining keys from enum values.
<K1> EnumContainerBuilder<K1,T>	keyGetter(@NonNull Function<? super T,K1> keyGetter) Sets the function to use for obtaining keys from enum values.
EnumContainerBuilder<K,T>	namespace(@Nullable String namespace) Sets the namespace for the container.
static <T extends Enum<?>> EnumContainerBuilder<Object,T>	of(@NonNull Class<T> enumType) Returns a new builder for the specified enum type.
EnumContainerBuilder<K,T>	propertyOperator(@NonNull PropertyOperator propertyOperator) Sets the property operator to use for reading properties from enum values.
EnumContainerBuilder<K,T>	value(@NonNull String value) Sets the value to use for obtaining values from enum values.
EnumContainerBuilder<K,T>	valueGetter(@NonNull Function<? super T,Object> valueGetter) Sets the function to use for obtaining values from enum values.

从类继承的方法 java.lang.Object

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

方法详细资料

of

public static <T extends Enum<?>> EnumContainerBuilder<Object,T> of(@NonNull Class<T> enumType)

Returns a new builder for the specified enum type.

类型参数:

T - the type of the enum values

参数:

enumType - the enum type to create a container for

返回:

a new builder instance

namespace

public EnumContainerBuilder<K,T> namespace(@Nullable String namespace)

Sets the namespace for the container.

参数:

namespace - the namespace to set

返回:

this builder instance

keyGetter

public <K1> EnumContainerBuilder<K1,T> keyGetter(@NonNull Function<? super T,K1> keyGetter)

Sets the function to use for obtaining keys from enum values.

类型参数:

K1 - the type of the keys returned by the key getter function

参数:

keyGetter - the key getter function to set

返回:

this builder instance

key

public EnumContainerBuilder<Object,T> key(@NonNull String key)

Sets the key to use for obtaining keys from enum values.

参数:

key - the key to set

返回:

this builder instance

抛出:

Crane4jException - throw when cannot find key getter of given property from enum type

valueGetter

public EnumContainerBuilder<K,T> valueGetter(@NonNull Function<? super T,Object> valueGetter)

Sets the function to use for obtaining values from enum values.

参数:

valueGetter - the value getter function to set

返回:

this builder instance

value

public EnumContainerBuilder<K,T> value(@NonNull String value)

Sets the value to use for obtaining values from enum values.

参数:

value - the value to set

返回:

this builder instance

抛出:

Crane4jException - throw when cannot find value getter of given property from enum type

enableContainerEnumAnnotation

public EnumContainerBuilder<K,T> enableContainerEnumAnnotation(boolean enableContainerEnumAnnotation)

Whether to enable resolves configuration from the specified ContainerEnum annotation.

参数:

enableContainerEnumAnnotation - enable container enum annotation

返回:

this builder instance

duplicateStrategy

public EnumContainerBuilder<K,T> duplicateStrategy(DuplicateStrategy duplicateStrategy)

Set processing strategy of when the key is duplicated.

参数:

duplicateStrategy - coverage strategy

返回:

this builder instance

从以下版本开始:

2.2.0

annotationFinder

public EnumContainerBuilder<K,T> annotationFinder(@NonNull AnnotationFinder annotationFinder)

Sets the annotation finder to use for reading the ContainerEnum annotation.

参数:

annotationFinder - the annotation finder to set

返回:

this builder instance

propertyOperator

public EnumContainerBuilder<K,T> propertyOperator(@NonNull PropertyOperator propertyOperator)

Sets the property operator to use for reading properties from enum values.

参数:

propertyOperator - the property operator to set

返回:

this builder instance

build

public Container<K> build()

Builds and returns an immutable container from the specified enum type and builder configuration.

返回:

an immutable container