Package com.polarion.platform.persistence.spi

Class TypedEnumeration

java.lang.Object

com.polarion.platform.persistence.spi.AbstractEnumeration

com.polarion.platform.persistence.spi.RepoBasedEnumeration

com.polarion.platform.persistence.spi.TypedEnumeration

All Implemented Interfaces:

IConfigurableEnumeration, IEnumeration

public class TypedEnumeration
extends RepoBasedEnumeration

Author:

POLARION SOFTWARE

Constructor Summary

Constructors

Constructor	Description
TypedEnumeration(Constructor<Object> enumConstructor, String cfgPath, String controlKey, IRepositoryConfigService rcs, String enumerationId, IContextId contextId)	Deprecated, for removal: This API element is subject to removal in a future version. The constructor is deprecated in favor of more flexible com.polarion.platform.persistence.spi.TypedEnumeration#TypedEnumeration(java.util.function.UnaryOperator, java.lang.String, java.lang.String, com.polarion.platform.repository.config.IRepositoryConfigService, java.lang.String, com.polarion.subterra.base.data.identification.IContextId)
TypedEnumeration(UnaryOperator<IEnumOption> wrapper, String cfgPath, String controlKey, IRepositoryConfigService rcs, String enumerationId, IContextId contextId)

Method Summary

Modifier and Type	Method	Description
String	getControlKey()	Default impl returns null.

Methods inherited from class com.polarion.platform.persistence.spi.RepoBasedEnumeration

getConfigurationId, getDefaultOption, getEnumerationFileName, getEnumerationFolder

Methods inherited from class com.polarion.platform.persistence.spi.AbstractEnumeration

getAllOptions, getAvailableOptions, getAvailableOptions, getDefaultOption, wrapOption, wrapOption, wrapOption

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.polarion.platform.persistence.IEnumeration

getAllOptions, getAvailableOptions, getAvailableOptions, getDefaultOption, wrapOption, wrapOption, wrapOption

Constructor Details

TypedEnumeration

@Deprecated(since="3.23.4",
            forRemoval=true)
public TypedEnumeration(Constructor<Object> enumConstructor,
 String cfgPath,
 String controlKey,
 IRepositoryConfigService rcs,
 String enumerationId,
 IContextId contextId)

Deprecated, for removal: This API element is subject to removal in a future version.

The constructor is deprecated in favor of more flexible com.polarion.platform.persistence.spi.TypedEnumeration#TypedEnumeration(java.util.function.UnaryOperator, java.lang.String, java.lang.String, com.polarion.platform.repository.config.IRepositoryConfigService, java.lang.String, com.polarion.subterra.base.data.identification.IContextId)

TypedEnumeration

public TypedEnumeration(@NotNull
 UnaryOperator<IEnumOption> wrapper,
 String cfgPath,
 String controlKey,
 IRepositoryConfigService rcs,
 String enumerationId,
 IContextId contextId)

Since:

3.23.4

Method Details

getControlKey

public String getControlKey()

Description copied from class: AbstractEnumeration

Default impl returns null. Override if necessary.

Specified by:

getControlKey in interface IEnumeration

Overrides:

getControlKey in class AbstractEnumeration

Returns:

Name of the key on the object, which controls the option set of this enumeration.