Package com.hybris.cockpitng.core.config

Interface CockpitConfigurationAdapter<CONFIG>

All Known Implementing Classes:

ActionsConfigurationAdapter, AdvancedSearchConfigAdapter, CompositeConfigAdapter, DefaultCompareViewConfigAdapter, DynamicFormsConfigAdapter, EditorAreaConfigAdapter, ExplorerTreeConfigAdapter, FlowConfigFieldsProcessorAdapter, FlowConfigPositionAdapter, FullTextSearchConfigAdapter, GridViewConfigAdapter, LinksConfigAdapter, ListViewConfigAdapter, PositionedConfigurationAdapter, SummaryViewConfigAdapter, TreeCollectionFilteringPositionAdapter

public interface CockpitConfigurationAdapter<CONFIG>

Adapts cockpit configuration element according to given context.

Method Summary

Modifier and Type	Method	Description
CONFIG	adaptAfterLoad(ConfigContext context, CONFIG config)	Adapts given cockpit configuration element after all subsequent configurations are loaded and merged.
default CONFIG	adaptBeforeMerge(ConfigContext context, CONFIG config)	Adapts given cockpit configuration element just after it is loaded and before it is merged to other subsequent configurations.
CONFIG	adaptBeforeStore(ConfigContext context, CONFIG config)	Adapts given cockpit configuration element before it is stored.
java.lang.Class<CONFIG>	getSupportedType()	Returns the type of configuration element this adapter supports.

Method Detail

getSupportedType

java.lang.Class<CONFIG> getSupportedType()

Returns the type of configuration element this adapter supports.

Returns:

type of configuration element this adapter supports

adaptBeforeMerge

default CONFIG adaptBeforeMerge(ConfigContext context,
                                CONFIG config)
                         throws CockpitConfigurationException

Adapts given cockpit configuration element just after it is loaded and before it is merged to other subsequent configurations.

Parameters:

context - configuration context

config - configuration element

Returns:

adapted cockpit configuration element

Throws:

CockpitConfigurationException - if something went wrong

adaptAfterLoad

CONFIG adaptAfterLoad(ConfigContext context,
                      CONFIG config)
               throws CockpitConfigurationException

Adapts given cockpit configuration element after all subsequent configurations are loaded and merged.

Parameters:

context - configuration context

config - configuration element

Returns:

adapted cockpit configuration element

Throws:

CockpitConfigurationException - if something went wrong

adaptBeforeStore

CONFIG adaptBeforeStore(ConfigContext context,
                        CONFIG config)
                 throws CockpitConfigurationException

Adapts given cockpit configuration element before it is stored.

Parameters:

context - configuration context

config - configuration element

Returns:

adapted cockpit configuration element

Throws:

CockpitConfigurationException - if something went wrong