Package de.fraunhofer.iosb.ilt.configurable

Interface Configurable<C,D>

Type Parameters:

C - The class type that provides context at runtime.

D - The class type that provides context while editing.

All Known Subinterfaces:

AnnotatedConfigurable<C,D>

All Known Implementing Classes:

AbstractConfigurable

public interface Configurable<C,D>

Author:

hylke

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLASS_CONFIG_EDITOR_FACTORY_METHOD_NAME

Method Summary

Modifier and Type	Method	Description
void	configure(com.google.gson.JsonElement config, C context, D edtCtx, ConfigEditor<?> configEditor)	Configure the instance using the given configuration.
ConfigEditor<?>	getConfigEditor(C context, D edtCtx)	Returns an editor for this class.

Field Detail

CLASS_CONFIG_EDITOR_FACTORY_METHOD_NAME

static final String CLASS_CONFIG_EDITOR_FACTORY_METHOD_NAME

See Also:

Constant Field Values

Method Detail

configure

void configure(com.google.gson.JsonElement config,
               C context,
               D edtCtx,
               ConfigEditor<?> configEditor)
        throws ConfigurationException

Configure the instance using the given configuration.

Parameters:

config - The configuration to use for this instance.

context - the object that defines the context at runtime.

edtCtx - the object that defines the context while editing.

configEditor - optional ConfigEditor that may be used to access and assign configured contents.

Throws:

ConfigurationException - If the configuration can not be loaded.

getConfigEditor

ConfigEditor<?> getConfigEditor(C context,
                                D edtCtx)

Returns an editor for this class. Changing the configuration of this editor may change the configuration of the instance that generated the editor, but it is not guaranteed to do so.

Parameters:

context - the object that defines the context at runtime.

edtCtx - the object that defines the context while editing.

Returns:

A generic editor for any instance of this class.